Data Source: oci_database_cloud_vm_clusters

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

data "oci_database_cloud_vm_clusters" "test_cloud_vm_clusters" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	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
}

Argument Reference

The following arguments are supported:

• cloud_exadata_infrastructure_id - (Optional) If provided, filters the results for the specified cloud Exadata infrastructure.
• compartment_id - (Required) The compartment OCID.
• display_name - (Optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
• state - (Optional) A filter to return only cloud VM clusters that match the given lifecycle state exactly.

Attributes Reference

The following attributes are exported:

• cloud_vm_clusters - The list of cloud_vm_clusters.

CloudVmCluster Reference

The following attributes are exported:

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

• backup_network_nsg_ids - 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.

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

  Subnet Restriction: See the subnet restrictions information for subnetId.

• cloud_automation_update_details - Specifies the properties necessary for cloud automation updates. This includes modifying the apply update time preference, enabling or disabling early adoption, and enabling, modifying, or disabling the update freeze period.

  • apply_update_time_preference - Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM.
    • apply_update_preferred_end_time - End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default.
    • apply_update_preferred_start_time - Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default.
  • freeze_period - Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days.
    • freeze_period_end_time - End time of the freeze period cycle.
    • freeze_period_start_time - Start time of the freeze period cycle.
  • is_early_adoption_enabled - Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week.
  • is_freeze_period_enabled - Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days.

• cloud_exadata_infrastructure_id - The OCID of the cloud Exadata infrastructure.

• cluster_name - 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.

• compartment_id - The OCID of the compartment.

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

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

  • is_diagnostics_events_enabled - 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 - 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 - 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.

• data_storage_percentage - 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.

• data_storage_size_in_tbs - The data disk group size to be allocated in TBs.

• db_node_storage_size_in_gbs - The local node storage to be allocated in GBs.

• db_servers - The list of DB servers.

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

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

• display_name - The user-friendly name for the cloud VM cluster. The name does not need to be unique.

• domain - The domain name for the cloud VM cluster.

• file_system_configuration_details - Details of the file system configuration of the VM cluster.

  • file_system_size_gb - The file system size to be allocated in GBs.
  • mount_point - The mount point of file system.

• freeform_tags - 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 - A valid Oracle Grid Infrastructure (GI) software version.

• hostname - The hostname for the cloud VM cluster.

• id - The OCID of the cloud VM cluster.

• is_local_backup_enabled - 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 - 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 - The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

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

• lifecycle_details - Additional information about the current lifecycle state.

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

• memory_size_in_gbs - The memory to be allocated in GBs.

• node_count - The number of nodes in the cloud VM cluster.

• nsg_ids - 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.

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

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

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

• scan_ip_ids - 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.

  Note: For a single-node DB system, this list is empty.

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

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

• security_attributes - Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

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

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

• state - The current state of the cloud VM cluster.

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

• subnet_id - The OCID of the subnet associated with the cloud VM cluster.

  Subnet Restrictions:

  • For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.

  These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

• subscription_id - The OCID of the subscription with which resource needs to be associated with.

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

• system_version - Operating system version of the image.

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

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

• vip_ids - 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.

  Note: For a single-node DB system, this list is empty.

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