oracle.oci.oci_database_cloud_autonomous_vm_cluster_facts – Fetches details about one or multiple CloudAutonomousVmCluster resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_cloud_autonomous_vm_cluster_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see ListAutonomousVmClusters.

  • If cloud_autonomous_vm_cluster_id is specified, the details of a single CloudAutonomousVmCluster 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.
availability_domain
string
A filter to return only resources that match the given availability domain exactly.
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.
cloud_autonomous_vm_cluster_id
string
The Cloud VM cluster OCID.
Required to get a specific cloud_autonomous_vm_cluster.

aliases: id
cloud_exadata_infrastructure_id
string
If provided, filters the results for the specified cloud Exadata infrastructure.
compartment_id
string
The compartment OCID.
Required to list multiple cloud_autonomous_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
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

Examples

- name: Get a specific cloud_autonomous_vm_cluster
  oci_database_cloud_autonomous_vm_cluster_facts:
    # required
    cloud_autonomous_vm_cluster_id: "ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"

- name: List cloud_autonomous_vm_clusters
  oci_database_cloud_autonomous_vm_cluster_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    cloud_exadata_infrastructure_id: "ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    sort_by: TIMECREATED
    sort_order: ASC
    lifecycle_state: PROVISIONING
    availability_domain: Uocm:PHX-AD-1
    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
cloud_autonomous_vm_clusters
complex
on success
List of CloudAutonomousVmCluster resources

Sample:
[{'autonomous_data_storage_size_in_tbs': 1.2, 'availability_domain': 'Uocm:PHX-AD-1', 'available_autonomous_data_storage_size_in_tbs': 1.2, 'available_container_databases': 56, 'available_cpus': 3.4, 'cloud_exadata_infrastructure_id': 'ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'cluster_time_zone': 'cluster_time_zone_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_core_count': 56, 'cpu_core_count_per_node': 56, 'data_storage_size_in_gbs': 1.2, 'data_storage_size_in_tbs': 1.2, 'db_node_storage_size_in_gbs': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'domain': 'domain_example', 'freeform_tags': {'Department': 'Finance'}, 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'last_maintenance_run_id': 'ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'last_update_history_entry_id': 'ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'maintenance_window': {'custom_action_timeout_in_mins': 56, 'days_of_week': [{'name': 'MONDAY'}], 'hours_of_day': [], 'is_custom_action_timeout_enabled': True, 'is_monthly_patching_enabled': True, 'lead_time_in_weeks': 56, 'months': [{'name': 'JANUARY'}], 'patching_mode': 'ROLLING', 'preference': 'NO_PREFERENCE', 'weeks_of_month': []}, 'memory_per_oracle_compute_unit_in_gbs': 56, 'memory_size_in_gbs': 56, 'next_maintenance_run_id': 'ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'node_count': 56, 'nsg_ids': [], 'ocpu_count': 3.4, 'reclaimable_cpus': 3.4, 'shape': 'shape_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_container_databases': 56}]
 
autonomous_data_storage_size_in_tbs
float
on success
The data disk group size allocated for Autonomous Databases, in TBs.

Sample:
1.2
 
availability_domain
string
on success
The name of the availability domain that the cloud Autonomous VM cluster is located in.

Sample:
Uocm:PHX-AD-1
 
available_autonomous_data_storage_size_in_tbs
float
on success
The data disk group size available for Autonomous Databases, in TBs.

Sample:
1.2
 
available_container_databases
integer
on success
The number of Autonomous Container Databases that can be created with the currently available local storage.

Sample:
56
 
available_cpus
float
on success
CPU cores available for allocation to Autonomous Databases.

Sample:
3.4
 
cloud_exadata_infrastructure_id
string
on success
The OCID of the cloud Exadata infrastructure.

Sample:
ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
cluster_time_zone
string
on success
The time zone of the Cloud Autonomous VM Cluster.

Sample:
cluster_time_zone_example
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cpu_core_count
integer
on success
The number of CPU cores on the cloud Autonomous VM cluster.

Sample:
56
 
cpu_core_count_per_node
integer
on success
The number of OCPU cores enabled per VM cluster node.

Sample:
56
 
data_storage_size_in_gbs
float
on success
The total data storage allocated, in gigabytes (GB).

Sample:
1.2
 
data_storage_size_in_tbs
float
on success
The total data storage allocated, in terabytes (TB).

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

Sample:
56
 
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'}}
 
description
string
on success
User defined description of the cloud Autonomous VM cluster.

Sample:
description_example
 
display_name
string
on success
The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique.

Sample:
display_name_example
 
domain
string
on success
The domain name for the cloud Autonomous VM cluster.

Sample:
domain_example
 
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'}
 
hostname
string
on success
The hostname for the cloud Autonomous VM cluster.

Sample:
hostname_example
 
id
string
on success
The OCID of the Cloud Autonomous VM cluster.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
last_maintenance_run_id
string
on success
The OCID of the last maintenance run.

Sample:
ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
 
last_update_history_entry_id
string
on success
The OCID of the last maintenance update history. This value is updated when a maintenance update starts.

Sample:
ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx
 
license_model
string
on success
The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on- premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`.

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 cloud Autonomous VM cluster.

Sample:
PROVISIONING
 
maintenance_window
complex
on success

   
custom_action_timeout_in_mins
integer
on success
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

Sample:
56
   
days_of_week
complex
on success
Days during the week when maintenance should be performed.

     
name
string
on success
Name of the day of the week.

Sample:
MONDAY
   
hours_of_day
list / elements=string
on success
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

   
is_custom_action_timeout_enabled
boolean
on success
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

Sample:
True
   
is_monthly_patching_enabled
boolean
on success
If true, enables the monthly patching option.

Sample:
True
   
lead_time_in_weeks
integer
on success
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Sample:
56
   
months
complex
on success
Months during the year when maintenance should be performed.

     
name
string
on success
Name of the month of the year.

Sample:
JANUARY
   
patching_mode
string
on success
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
*IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Sample:
ROLLING
   
preference
string
on success
The maintenance window scheduling preference.

Sample:
NO_PREFERENCE
   
weeks_of_month
list / elements=string
on success
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

 
memory_per_oracle_compute_unit_in_gbs
integer
on success
The amount of memory (in GBs) enabled per each OCPU core.

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

Sample:
56
 
next_maintenance_run_id
string
on success
The OCID of the next maintenance run.

Sample:
ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
 
node_count
integer
on success
The number of database servers in the cloud VM cluster.

Sample:
56
 
nsg_ids
list / elements=string
on success
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
float
on success
The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part.

Sample:
3.4
 
reclaimable_cpus
float
on success
CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

Sample:
3.4
 
shape
string
on success
The model name of the Exadata hardware running the cloud Autonomous VM cluster.

Sample:
shape_example
 
subnet_id
string
on success
The OCID of the subnet the cloud Autonomous VM Cluster is associated with.
**Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC DB 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.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time that the cloud Autonomous VM cluster was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The last date and time that the cloud Autonomous VM cluster was updated.

Sample:
2013-10-20T19:20:30+01:00
 
total_container_databases
integer
on success
The total number of Autonomous Container Databases that can be created with the allocated local storage.

Sample:
56


Authors

  • Oracle (@oracle)