oracle.oci.oci_database_autonomous_vm_cluster_facts – Fetches details about one or multiple AutonomousVmCluster resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_autonomous_vm_cluster_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AutonomousVmCluster resources in Oracle Cloud Infrastructure
Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see ListCloudAutonomousVmClusters.
If autonomous_vm_cluster_id is specified, the details of a single AutonomousVmCluster will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
autonomous_vm_cluster_id
string
|
The autonomous VM cluster OCID.
Required to get a specific autonomous_vm_cluster.
aliases: id |
|
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 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 |
|
exadata_infrastructure_id
string
|
If provided, filters the results for the given Exadata Infrastructure.
|
|
lifecycle_state
string
|
|
A filter to return only resources that match the given lifecycle state exactly.
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
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
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific autonomous_vm_cluster
oci_database_autonomous_vm_cluster_facts:
# required
autonomous_vm_cluster_id: "ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
- name: List autonomous_vm_clusters
oci_database_autonomous_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 | |||
---|---|---|---|---|---|
autonomous_vm_clusters
complex
|
on success |
List of AutonomousVmCluster resources
Sample:
[{'autonomous_data_storage_size_in_tbs': 1.2, 'available_autonomous_data_storage_size_in_tbs': 1.2, 'available_container_databases': 56, 'available_cpus': 56, 'available_data_storage_size_in_tbs': 1.2, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_model': 'ECPU', 'cpu_core_count_per_node': 56, 'cpus_enabled': 56, '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'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_local_backup_enabled': True, 'is_mtls_enabled': True, 'last_maintenance_run_id': 'ocid1.lastmaintenancerun.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, 'ocpus_enabled': 3.4, 'reclaimable_cpus': 56, 'scan_listener_port_non_tls': 56, 'scan_listener_port_tls': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_database_ssl_certificate_expires': '2013-10-20T19:20:30+01:00', 'time_ords_certificate_expires': '2013-10-20T19:20:30+01:00', 'time_zone': 'time_zone_example', 'total_container_databases': 56, 'vm_cluster_network_id': 'ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|||
autonomous_data_storage_size_in_tbs
float
|
on success |
The data disk group size allocated for Autonomous Databases, in TBs.
Sample:
1.2
|
|||
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
integer
|
on success |
The numnber of CPU cores available.
Sample:
56
|
|||
available_data_storage_size_in_tbs
float
|
on success |
**Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs.
Sample:
1.2
|
|||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
compute_model
string
|
on success |
The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure for more details.
Sample:
ECPU
|
|||
cpu_core_count_per_node
integer
|
on success |
The number of CPU cores enabled per VM cluster node.
Sample:
56
|
|||
cpus_enabled
integer
|
on success |
The number of enabled CPU cores.
Sample:
56
|
|||
data_storage_size_in_gbs
float
|
on success |
The total data storage allocated in GBs.
Sample:
1.2
|
|||
data_storage_size_in_tbs
float
|
on success |
The total data storage allocated in TBs
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 OCIDs of the Db servers.
|
|||
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 Autonomous 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'}
|
|||
id
string
|
on success |
The OCID of the Autonomous 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 Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster.
Sample:
True
|
|||
is_mtls_enabled
boolean
|
on success |
Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS.
Sample:
True
|
|||
last_maintenance_run_id
string
|
on success |
The OCID of the last maintenance run.
Sample:
ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
|
|||
license_model
string
|
on success |
The Oracle license model that applies to the Autonomous 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 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) to be enabled per OCPU or ECPU.
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 nodes in the Autonomous VM Cluster.
Sample:
56
|
|||
ocpus_enabled
float
|
on success |
The number of enabled OCPU cores.
Sample:
3.4
|
|||
reclaimable_cpus
integer
|
on success |
CPUs that continue to be included in the count of CPUs 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 CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database.
Sample:
56
|
|||
scan_listener_port_non_tls
integer
|
on success |
The SCAN Listener Non TLS port number. Default value is 1521.
Sample:
56
|
|||
scan_listener_port_tls
integer
|
on success |
The SCAN Listener TLS port number. Default value is 2484.
Sample:
56
|
|||
time_created
string
|
on success |
The date and time that the Autonomous VM cluster was created.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_database_ssl_certificate_expires
string
|
on success |
The date and time of the Database SSL certificate expiration.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_ords_certificate_expires
string
|
on success |
The date and time of the ORDS certificate expiration.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_zone
string
|
on success |
The time zone to use for the Autonomous VM cluster. For details, see DB System Time Zones.
Sample:
time_zone_example
|
|||
total_container_databases
integer
|
on success |
The total number of Autonomous Container Databases that can be created.
Sample:
56
|
|||
vm_cluster_network_id
string
|
on success |
The OCID of the VM cluster network.
Sample:
ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)