oracle.oci.oci_database_vm_cluster_facts – Fetches details about one or multiple VmCluster resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_database_vm_cluster_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple VmCluster resources in Oracle Cloud Infrastructure

  • Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the ListCloudVmClusters operation.

  • If vm_cluster_id is specified, the details of a single VmCluster will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The compartment OCID.
Required to list multiple vm_clusters.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
display_name
string
A filter to return only resources that match the entire display name given. The match is not case sensitive.

aliases: name
exadata_infrastructure_id
string
If provided, filters the results for the given Exadata Infrastructure.
lifecycle_state
string
    Choices:
  • PROVISIONING
  • AVAILABLE
  • UPDATING
  • TERMINATING
  • TERMINATED
  • FAILED
  • MAINTENANCE_IN_PROGRESS
A filter to return only resources that match the given lifecycle state exactly.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
vm_cluster_id
string
The VM cluster OCID.
Required to get a specific vm_cluster.

aliases: id

Examples

- name: Get a specific vm_cluster
  oci_database_vm_cluster_facts:
    # required
    vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"

- name: List vm_clusters
  oci_database_vm_cluster_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    sort_by: TIMECREATED
    sort_order: ASC
    lifecycle_state: PROVISIONING
    display_name: display_name_example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vm_clusters
complex
on success
List of VmCluster resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cpus_enabled': 56, 'data_collection_options': {'is_diagnostics_events_enabled': True, 'is_health_monitoring_enabled': True, 'is_incident_logs_enabled': True}, 'data_storage_size_in_gbs': 1.2, 'data_storage_size_in_tbs': 1.2, 'db_node_storage_size_in_gbs': 56, 'db_servers': [], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'exadata_infrastructure_id': 'ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'gi_version': 'gi_version_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_local_backup_enabled': True, 'is_sparse_diskgroup_enabled': True, 'last_patch_history_entry_id': 'ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'memory_size_in_gbs': 56, 'ocpus_enabled': 3.4, 'shape': 'shape_example', 'ssh_public_keys': ['ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...'], 'system_version': 'system_version_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_zone': 'time_zone_example', 'vm_cluster_network_id': 'ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx'}]
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cpus_enabled
integer
on success
The number of enabled CPU cores.

Sample:
56
 
data_collection_options
complex
on success

   
is_diagnostics_events_enabled
boolean
on success
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.

Sample:
True
   
is_health_monitoring_enabled
boolean
on success
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.

Sample:
True
   
is_incident_logs_enabled
boolean
on success
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.

Sample:
True
 
data_storage_size_in_gbs
float
on success
Size of the DATA disk group in GBs.

Sample:
1.2
 
data_storage_size_in_tbs
float
on success
Size, in terabytes, of the DATA disk group.

Sample:
1.2
 
db_node_storage_size_in_gbs
integer
on success
The local node storage allocated in GBs.

Sample:
56
 
db_servers
list / elements=string
on success
The list of Db server.

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

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique.

Sample:
display_name_example
 
exadata_infrastructure_id
string
on success
The OCID of the Exadata infrastructure.

Sample:
ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
gi_version
string
on success
The Oracle Grid Infrastructure software version for the VM cluster.

Sample:
gi_version_example
 
id
string
on success
The OCID of the VM cluster.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_local_backup_enabled
boolean
on success
If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.

Sample:
True
 
is_sparse_diskgroup_enabled
boolean
on success
If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created.

Sample:
True
 
last_patch_history_entry_id
string
on success
The OCID of the last patch history. This value is updated as soon as a patch operation starts.

Sample:
ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
 
license_model
string
on success
The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED.

Sample:
LICENSE_INCLUDED
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the VM cluster.

Sample:
PROVISIONING
 
memory_size_in_gbs
integer
on success
The memory allocated in GBs.

Sample:
56
 
ocpus_enabled
float
on success
The number of enabled OCPU cores.

Sample:
3.4
 
shape
string
on success
The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

Sample:
shape_example
 
ssh_public_keys
list / elements=string
on success
The public key portion of one or more key pairs used for SSH access to the VM cluster.

Sample:
['ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...']
 
system_version
string
on success
Operating system version of the image.

Sample:
system_version_example
 
time_created
string
on success
The date and time that the VM cluster was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_zone
string
on success
The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

Sample:
time_zone_example
 
vm_cluster_network_id
string
on success
The OCID of the VM cluster network.

Sample:
ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)