Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Database.getCloudVmClusters

This data source provides the list of Cloud Vm Clusters in Oracle Cloud Infrastructure Database service.

Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCloudVmClusters = Oci.Database.GetCloudVmClusters.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        CloudExadataInfrastructureId = oci_database_cloud_exadata_infrastructure.Test_cloud_exadata_infrastructure.Id,
        DisplayName = @var.Cloud_vm_cluster_display_name,
        State = @var.Cloud_vm_cluster_state,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.GetCloudVmClusters(ctx, &database.GetCloudVmClustersArgs{
			CompartmentId:                _var.Compartment_id,
			CloudExadataInfrastructureId: pulumi.StringRef(oci_database_cloud_exadata_infrastructure.Test_cloud_exadata_infrastructure.Id),
			DisplayName:                  pulumi.StringRef(_var.Cloud_vm_cluster_display_name),
			State:                        pulumi.StringRef(_var.Cloud_vm_cluster_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetCloudVmClustersArgs;
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 testCloudVmClusters = DatabaseFunctions.getCloudVmClusters(GetCloudVmClustersArgs.builder()
            .compartmentId(var_.compartment_id())
            .cloudExadataInfrastructureId(oci_database_cloud_exadata_infrastructure.test_cloud_exadata_infrastructure().id())
            .displayName(var_.cloud_vm_cluster_display_name())
            .state(var_.cloud_vm_cluster_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_cloud_vm_clusters = oci.Database.get_cloud_vm_clusters(compartment_id=var["compartment_id"],
    cloud_exadata_infrastructure_id=oci_database_cloud_exadata_infrastructure["test_cloud_exadata_infrastructure"]["id"],
    display_name=var["cloud_vm_cluster_display_name"],
    state=var["cloud_vm_cluster_state"])

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCloudVmClusters = oci.Database.getCloudVmClusters({
    compartmentId: _var.compartment_id,
    cloudExadataInfrastructureId: oci_database_cloud_exadata_infrastructure.test_cloud_exadata_infrastructure.id,
    displayName: _var.cloud_vm_cluster_display_name,
    state: _var.cloud_vm_cluster_state,
});

variables:
  testCloudVmClusters:
    fn::invoke:
      Function: oci:Database:getCloudVmClusters
      Arguments:
        compartmentId: ${var.compartment_id}
        cloudExadataInfrastructureId: ${oci_database_cloud_exadata_infrastructure.test_cloud_exadata_infrastructure.id}
        displayName: ${var.cloud_vm_cluster_display_name}
        state: ${var.cloud_vm_cluster_state}

Using getCloudVmClusters

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 getCloudVmClusters(args: GetCloudVmClustersArgs, opts?: InvokeOptions): Promise<GetCloudVmClustersResult>
function getCloudVmClustersOutput(args: GetCloudVmClustersOutputArgs, opts?: InvokeOptions): Output<GetCloudVmClustersResult>

def get_cloud_vm_clusters(cloud_exadata_infrastructure_id: Optional[str] = None,
                          compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_database.GetCloudVmClustersFilter]] = None,
                          state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCloudVmClustersResult
def get_cloud_vm_clusters_output(cloud_exadata_infrastructure_id: Optional[pulumi.Input[str]] = None,
                          compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetCloudVmClustersFilterArgs]]]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudVmClustersResult]

func GetCloudVmClusters(ctx *Context, args *GetCloudVmClustersArgs, opts ...InvokeOption) (*GetCloudVmClustersResult, error)
func GetCloudVmClustersOutput(ctx *Context, args *GetCloudVmClustersOutputArgs, opts ...InvokeOption) GetCloudVmClustersResultOutput

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

public static class GetCloudVmClusters 
{
    public static Task<GetCloudVmClustersResult> InvokeAsync(GetCloudVmClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudVmClustersResult> Invoke(GetCloudVmClustersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudVmClustersResult> getCloudVmClusters(GetCloudVmClustersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Database/getCloudVmClusters:getCloudVmClusters
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The compartment OCID.
CloudExadataInfrastructureId string: If provided, filters the results for the specified cloud Exadata infrastructure.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters List<GetCloudVmClustersFilter>
State string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

CompartmentId string: The compartment OCID.
CloudExadataInfrastructureId string: If provided, filters the results for the specified cloud Exadata infrastructure.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters []GetCloudVmClustersFilter
State string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

compartmentId String: The compartment OCID.
cloudExadataInfrastructureId String: If provided, filters the results for the specified cloud Exadata infrastructure.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<GetCloudVmClustersFilter>
state String: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

compartmentId string: The compartment OCID.
cloudExadataInfrastructureId string: If provided, filters the results for the specified cloud Exadata infrastructure.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters GetCloudVmClustersFilter[]
state string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

compartment_id str: The compartment OCID.
cloud_exadata_infrastructure_id str: If provided, filters the results for the specified cloud Exadata infrastructure.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters GetCloudVmClustersFilter]
state str: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

compartmentId String: The compartment OCID.
cloudExadataInfrastructureId String: If provided, filters the results for the specified cloud Exadata infrastructure.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<Property Map>
state String: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

getCloudVmClusters Result

The following output properties are available:

CloudVmClusters List<GetCloudVmClustersCloudVmCluster>: The list of cloud_vm_clusters.
CompartmentId string: The OCID of the compartment.
Id string: The provider-assigned unique ID for this managed resource.
CloudExadataInfrastructureId string: The OCID of the cloud Exadata infrastructure.
DisplayName string: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
Filters List<GetCloudVmClustersFilter>
State string: The current state of the cloud VM cluster.

CloudVmClusters []GetCloudVmClustersCloudVmCluster: The list of cloud_vm_clusters.
CompartmentId string: The OCID of the compartment.
Id string: The provider-assigned unique ID for this managed resource.
CloudExadataInfrastructureId string: The OCID of the cloud Exadata infrastructure.
DisplayName string: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
Filters []GetCloudVmClustersFilter
State string: The current state of the cloud VM cluster.

cloudVmClusters List<GetCloudVmClustersCloudVmCluster>: The list of cloud_vm_clusters.
compartmentId String: The OCID of the compartment.
id String: The provider-assigned unique ID for this managed resource.
cloudExadataInfrastructureId String: The OCID of the cloud Exadata infrastructure.
displayName String: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
filters List<GetCloudVmClustersFilter>
state String: The current state of the cloud VM cluster.

cloudVmClusters GetCloudVmClustersCloudVmCluster[]: The list of cloud_vm_clusters.
compartmentId string: The OCID of the compartment.
id string: The provider-assigned unique ID for this managed resource.
cloudExadataInfrastructureId string: The OCID of the cloud Exadata infrastructure.
displayName string: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
filters GetCloudVmClustersFilter[]
state string: The current state of the cloud VM cluster.

cloud_vm_clusters GetCloudVmClustersCloudVmCluster]: The list of cloud_vm_clusters.
compartment_id str: The OCID of the compartment.
id str: The provider-assigned unique ID for this managed resource.
cloud_exadata_infrastructure_id str: The OCID of the cloud Exadata infrastructure.
display_name str: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
filters GetCloudVmClustersFilter]
state str: The current state of the cloud VM cluster.

cloudVmClusters List<Property Map>: The list of cloud_vm_clusters.
compartmentId String: The OCID of the compartment.
id String: The provider-assigned unique ID for this managed resource.
cloudExadataInfrastructureId String: The OCID of the cloud Exadata infrastructure.
displayName String: The user-friendly name for the cloud VM cluster. The name does not need to be unique.
filters List<Property Map>
state String: The current state of the cloud VM cluster.

Supporting Types

GetCloudVmClustersCloudVmCluster

AvailabilityDomain string

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

BackupNetworkNsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

BackupSubnetId string

The OCID of the backup network subnet associated with the cloud VM cluster.

CloudExadataInfrastructureId string

If provided, filters the results for the specified cloud Exadata infrastructure.

ClusterName string

The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

CompartmentId string

The compartment OCID.

CpuCoreCount int

The number of CPU cores enabled on the cloud VM cluster.

CreateAsync bool

DataCollectionOptions List<GetCloudVmClustersCloudVmClusterDataCollectionOption>

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

DataStorageSizeInTbs double

The data disk group size to be allocated in TBs.

DbNodeStorageSizeInGbs int

The local node storage to be allocated in GBs.

DbServers List<string>

The list of DB servers.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Domain string

The domain name for the cloud VM cluster.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

GiVersion string

A valid Oracle Grid Infrastructure (GI) software version.

Hostname string

The hostname for the cloud VM cluster.

Id string

The OCID of the cloud VM cluster.

IormConfigCaches List<GetCloudVmClustersCloudVmClusterIormConfigCach>

IsLocalBackupEnabled bool

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

IsSparseDiskgroupEnabled bool

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

LastUpdateHistoryEntryId string

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

LicenseModel string

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycle state.

ListenerPort string

The port number configured for the listener on the cloud VM cluster.

MemorySizeInGbs int

The memory to be allocated in GBs.

NodeCount int

The number of nodes in the cloud VM cluster.

NsgIds List<string>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

OcpuCount double

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

PrivateZoneId string

ScanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanIpIds List<string>

The OCID of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

ScanListenerPortTcp int

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

ScanListenerPortTcpSsl int

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Shape string

The model name of the Exadata hardware running the cloud VM cluster.

SshPublicKeys List<string>

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

State string

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

StorageSizeInGbs int

The storage allocation for the disk group, in gigabytes (GB).

SubnetId string

The OCID of the subnet associated with the cloud VM cluster.

SystemVersion string

Operating system version of the image.

TimeCreated string

The date and time that the cloud VM cluster was created.

TimeZone string

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

VipIds List<string>

The OCID of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

ZoneId string

The OCID of the zone the cloud VM cluster is associated with.

AvailabilityDomain string

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

BackupNetworkNsgIds []string

BackupSubnetId string

The OCID of the backup network subnet associated with the cloud VM cluster.

CloudExadataInfrastructureId string

If provided, filters the results for the specified cloud Exadata infrastructure.

ClusterName string

CompartmentId string

The compartment OCID.

CpuCoreCount int

The number of CPU cores enabled on the cloud VM cluster.

CreateAsync bool

DataCollectionOptions []GetCloudVmClustersCloudVmClusterDataCollectionOption

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

DataStorageSizeInTbs float64

The data disk group size to be allocated in TBs.

DbNodeStorageSizeInGbs int

The local node storage to be allocated in GBs.

DbServers []string

The list of DB servers.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Domain string

The domain name for the cloud VM cluster.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

GiVersion string

A valid Oracle Grid Infrastructure (GI) software version.

Hostname string

The hostname for the cloud VM cluster.

Id string

The OCID of the cloud VM cluster.

IormConfigCaches []GetCloudVmClustersCloudVmClusterIormConfigCach

IsLocalBackupEnabled bool

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

IsSparseDiskgroupEnabled bool

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

LastUpdateHistoryEntryId string

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

LicenseModel string

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycle state.

ListenerPort string

The port number configured for the listener on the cloud VM cluster.

MemorySizeInGbs int

The memory to be allocated in GBs.

NodeCount int

The number of nodes in the cloud VM cluster.

NsgIds []string

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

OcpuCount float64

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

PrivateZoneId string

ScanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

ScanIpIds []string

ScanListenerPortTcp int

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

ScanListenerPortTcpSsl int

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Shape string

The model name of the Exadata hardware running the cloud VM cluster.

SshPublicKeys []string

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

State string

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

StorageSizeInGbs int

The storage allocation for the disk group, in gigabytes (GB).

SubnetId string

The OCID of the subnet associated with the cloud VM cluster.

SystemVersion string

Operating system version of the image.

TimeCreated string

The date and time that the cloud VM cluster was created.

TimeZone string

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

VipIds []string

ZoneId string

The OCID of the zone the cloud VM cluster is associated with.

availabilityDomain String

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet associated with the cloud VM cluster.

cloudExadataInfrastructureId String

If provided, filters the results for the specified cloud Exadata infrastructure.

clusterName String

compartmentId String

The compartment OCID.

cpuCoreCount Integer

The number of CPU cores enabled on the cloud VM cluster.

createAsync Boolean

dataCollectionOptions List<GetCloudVmClustersCloudVmClusterDataCollectionOption>

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Integer

dataStorageSizeInTbs Double

The data disk group size to be allocated in TBs.

dbNodeStorageSizeInGbs Integer

The local node storage to be allocated in GBs.

dbServers List<String>

The list of DB servers.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

domain String

The domain name for the cloud VM cluster.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

giVersion String

A valid Oracle Grid Infrastructure (GI) software version.

hostname String

The hostname for the cloud VM cluster.

id String

The OCID of the cloud VM cluster.

iormConfigCaches List<GetCloudVmClustersCloudVmClusterIormConfigCach>

isLocalBackupEnabled Boolean

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

isSparseDiskgroupEnabled Boolean

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

lastUpdateHistoryEntryId String

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

licenseModel String

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycle state.

listenerPort String

The port number configured for the listener on the cloud VM cluster.

memorySizeInGbs Integer

The memory to be allocated in GBs.

nodeCount Integer

The number of nodes in the cloud VM cluster.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

ocpuCount Double

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

privateZoneId String

scanDnsName String

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsRecordId String

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanIpIds List<String>

scanListenerPortTcp Integer

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scanListenerPortTcpSsl Integer

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

shape String

The model name of the Exadata hardware running the cloud VM cluster.

sshPublicKeys List<String>

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

state String

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

storageSizeInGbs Integer

The storage allocation for the disk group, in gigabytes (GB).

subnetId String

The OCID of the subnet associated with the cloud VM cluster.

systemVersion String

Operating system version of the image.

timeCreated String

The date and time that the cloud VM cluster was created.

timeZone String

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

vipIds List<String>

zoneId String

The OCID of the zone the cloud VM cluster is associated with.

availabilityDomain string

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

backupNetworkNsgIds string[]

backupSubnetId string

The OCID of the backup network subnet associated with the cloud VM cluster.

cloudExadataInfrastructureId string

If provided, filters the results for the specified cloud Exadata infrastructure.

clusterName string

compartmentId string

The compartment OCID.

cpuCoreCount number

The number of CPU cores enabled on the cloud VM cluster.

createAsync boolean

dataCollectionOptions GetCloudVmClustersCloudVmClusterDataCollectionOption[]

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage number

dataStorageSizeInTbs number

The data disk group size to be allocated in TBs.

dbNodeStorageSizeInGbs number

The local node storage to be allocated in GBs.

dbServers string[]

The list of DB servers.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy string

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

displayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

domain string

The domain name for the cloud VM cluster.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

giVersion string

A valid Oracle Grid Infrastructure (GI) software version.

hostname string

The hostname for the cloud VM cluster.

id string

The OCID of the cloud VM cluster.

iormConfigCaches GetCloudVmClustersCloudVmClusterIormConfigCach[]

isLocalBackupEnabled boolean

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

isSparseDiskgroupEnabled boolean

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

lastUpdateHistoryEntryId string

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

licenseModel string

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

lifecycleDetails string

Additional information about the current lifecycle state.

listenerPort string

The port number configured for the listener on the cloud VM cluster.

memorySizeInGbs number

The memory to be allocated in GBs.

nodeCount number

The number of nodes in the cloud VM cluster.

nsgIds string[]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

ocpuCount number

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

privateZoneId string

scanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanIpIds string[]

scanListenerPortTcp number

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scanListenerPortTcpSsl number

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

shape string

The model name of the Exadata hardware running the cloud VM cluster.

sshPublicKeys string[]

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

state string

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

storageSizeInGbs number

The storage allocation for the disk group, in gigabytes (GB).

subnetId string

The OCID of the subnet associated with the cloud VM cluster.

systemVersion string

Operating system version of the image.

timeCreated string

The date and time that the cloud VM cluster was created.

timeZone string

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

vipIds string[]

zoneId string

The OCID of the zone the cloud VM cluster is associated with.

availability_domain str

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

backup_network_nsg_ids Sequence[str]

backup_subnet_id str

The OCID of the backup network subnet associated with the cloud VM cluster.

cloud_exadata_infrastructure_id str

If provided, filters the results for the specified cloud Exadata infrastructure.

cluster_name str

compartment_id str

The compartment OCID.

cpu_core_count int

The number of CPU cores enabled on the cloud VM cluster.

create_async bool

data_collection_options GetCloudVmClustersCloudVmClusterDataCollectionOption]

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

data_storage_percentage int

data_storage_size_in_tbs float

The data disk group size to be allocated in TBs.

db_node_storage_size_in_gbs int

The local node storage to be allocated in GBs.

db_servers Sequence[str]

The list of DB servers.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

disk_redundancy str

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

display_name str

A filter to return only resources that match the entire display name given. The match is not case sensitive.

domain str

The domain name for the cloud VM cluster.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

gi_version str

A valid Oracle Grid Infrastructure (GI) software version.

hostname str

The hostname for the cloud VM cluster.

id str

The OCID of the cloud VM cluster.

iorm_config_caches GetCloudVmClustersCloudVmClusterIormConfigCach]

is_local_backup_enabled bool

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

is_sparse_diskgroup_enabled bool

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

last_update_history_entry_id str

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

license_model str

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

lifecycle_details str

Additional information about the current lifecycle state.

listener_port str

The port number configured for the listener on the cloud VM cluster.

memory_size_in_gbs int

The memory to be allocated in GBs.

node_count int

The number of nodes in the cloud VM cluster.

nsg_ids Sequence[str]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

ocpu_count float

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

private_zone_id str

scan_dns_name str

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scan_dns_record_id str

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scan_ip_ids Sequence[str]

scan_listener_port_tcp int

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scan_listener_port_tcp_ssl int

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

shape str

The model name of the Exadata hardware running the cloud VM cluster.

ssh_public_keys Sequence[str]

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

state str

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

storage_size_in_gbs int

The storage allocation for the disk group, in gigabytes (GB).

subnet_id str

The OCID of the subnet associated with the cloud VM cluster.

system_version str

Operating system version of the image.

time_created str

The date and time that the cloud VM cluster was created.

time_zone str

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

vip_ids Sequence[str]

zone_id str

The OCID of the zone the cloud VM cluster is associated with.

availabilityDomain String

The name of the availability domain that the cloud Exadata infrastructure resource is located in.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet associated with the cloud VM cluster.

cloudExadataInfrastructureId String

If provided, filters the results for the specified cloud Exadata infrastructure.

clusterName String

compartmentId String

The compartment OCID.

cpuCoreCount Number

The number of CPU cores enabled on the cloud VM cluster.

createAsync Boolean

dataCollectionOptions List<Property Map>

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Number

dataStorageSizeInTbs Number

The data disk group size to be allocated in TBs.

dbNodeStorageSizeInGbs Number

The local node storage to be allocated in GBs.

dbServers List<String>

The list of DB servers.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

domain String

The domain name for the cloud VM cluster.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

giVersion String

A valid Oracle Grid Infrastructure (GI) software version.

hostname String

The hostname for the cloud VM cluster.

id String

The OCID of the cloud VM cluster.

iormConfigCaches List<Property Map>

isLocalBackupEnabled Boolean

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

isSparseDiskgroupEnabled Boolean

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

lastUpdateHistoryEntryId String

The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

licenseModel String

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycle state.

listenerPort String

The port number configured for the listener on the cloud VM cluster.

memorySizeInGbs Number

The memory to be allocated in GBs.

nodeCount Number

The number of nodes in the cloud VM cluster.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

ocpuCount Number

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

privateZoneId String

scanDnsName String

The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanDnsRecordId String

The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

scanIpIds List<String>

scanListenerPortTcp Number

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

scanListenerPortTcpSsl Number

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

shape String

The model name of the Exadata hardware running the cloud VM cluster.

sshPublicKeys List<String>

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

state String

A filter to return only cloud VM clusters that match the given lifecycle state exactly.

storageSizeInGbs Number

The storage allocation for the disk group, in gigabytes (GB).

subnetId String

The OCID of the subnet associated with the cloud VM cluster.

systemVersion String

Operating system version of the image.

timeCreated String

The date and time that the cloud VM cluster was created.

timeZone String

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

vipIds List<String>

zoneId String

The OCID of the zone the cloud VM cluster is associated with.

GetCloudVmClustersCloudVmClusterDataCollectionOption

IsDiagnosticsEventsEnabled bool: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled bool: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled bool: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

IsDiagnosticsEventsEnabled bool: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled bool: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled bool: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled Boolean: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled Boolean: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled boolean: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled boolean: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled boolean: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

is_diagnostics_events_enabled bool: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
is_health_monitoring_enabled bool: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
is_incident_logs_enabled bool: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled Boolean: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled Boolean: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

GetCloudVmClustersCloudVmClusterIormConfigCach

DbPlans List<GetCloudVmClustersCloudVmClusterIormConfigCachDbPlan>
LifecycleDetails string: Additional information about the current lifecycle state.
Objective string
State string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

DbPlans []GetCloudVmClustersCloudVmClusterIormConfigCachDbPlan
LifecycleDetails string: Additional information about the current lifecycle state.
Objective string
State string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

dbPlans List<GetCloudVmClustersCloudVmClusterIormConfigCachDbPlan>
lifecycleDetails String: Additional information about the current lifecycle state.
objective String
state String: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

dbPlans GetCloudVmClustersCloudVmClusterIormConfigCachDbPlan[]
lifecycleDetails string: Additional information about the current lifecycle state.
objective string
state string: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

db_plans GetCloudVmClustersCloudVmClusterIormConfigCachDbPlan]
lifecycle_details str: Additional information about the current lifecycle state.
objective str
state str: A filter to return only cloud VM clusters that match the given lifecycle state exactly.

dbPlans List<Property Map>
lifecycleDetails String: Additional information about the current lifecycle state.
objective String
state String: A filter to return only cloud VM clusters that match the given lifecycle state exactly.