Try SpotterFetches details about one or multiple CloudAutonomousVmCluster resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections:
- name: oracle.oci
version: 4.2.0Fetches 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 L(ListAutonomousVmClusters,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters).
If I(cloud_autonomous_vm_cluster_id) is specified, the details of a single CloudAutonomousVmCluster will be returned.
- 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
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- 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.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`).
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
aliases:
- name
description:
- A filter to return only resources that match the entire display name given. The
match is not case sensitive.
type: str
compartment_id:
description:
- The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to list multiple cloud_autonomous_vm_clusters.
type: str
lifecycle_state:
choices:
- PROVISIONING
- AVAILABLE
- UPDATING
- TERMINATING
- TERMINATED
- FAILED
- MAINTENANCE_IN_PROGRESS
description:
- A filter to return only resources that match the given lifecycle state exactly.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
availability_domain:
description:
- A filter to return only resources that match the given availability domain exactly.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
cloud_autonomous_vm_cluster_id:
aliases:
- id
description:
- The Cloud VM cluster L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific cloud_autonomous_vm_cluster.
type: str
cloud_exadata_infrastructure_id:
description:
- If provided, filters the results for the specified cloud Exadata infrastructure.
type: str
cloud_autonomous_vm_clusters:
contains:
autonomous_data_storage_size_in_tbs:
description:
- The data disk group size allocated for Autonomous Databases, in TBs.
returned: on success
sample: 1.2
type: float
availability_domain:
description:
- The name of the availability domain that the cloud Autonomous VM cluster is
located in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
available_autonomous_data_storage_size_in_tbs:
description:
- The data disk group size available for Autonomous Databases, in TBs.
returned: on success
sample: 1.2
type: float
available_container_databases:
description:
- The number of Autonomous Container Databases that can be created with the
currently available local storage.
returned: on success
sample: 56
type: int
available_cpus:
description:
- CPU cores available for allocation to Autonomous Databases.
returned: on success
sample: 3.4
type: float
cloud_exadata_infrastructure_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud Exadata infrastructure.
returned: on success
sample: ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
type: str
cluster_time_zone:
description:
- The time zone of the Cloud Autonomous VM Cluster.
returned: on success
sample: cluster_time_zone_example
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpu_core_count:
description:
- The number of CPU cores enabled on the cloud Autonomous VM cluster.
returned: on success
sample: 56
type: int
data_storage_size_in_gbs:
description:
- The total data storage allocated, in gigabytes (GB).
returned: on success
sample: 1.2
type: float
data_storage_size_in_tbs:
description:
- The total data storage allocated, in terabytes (TB).
returned: on success
sample: 1.2
type: float
db_node_storage_size_in_gbs:
description:
- The local node storage allocated in GBs.
returned: on success
sample: 56
type: int
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
returned: on success
sample:
Operations:
CostCenter: US
type: dict
description:
description:
- User defined description of the cloud Autonomous VM cluster.
returned: on success
sample: description_example
type: str
display_name:
description:
- The user-friendly name for the cloud Autonomous VM cluster. The name does
not need to be unique.
returned: on success
sample: display_name_example
type: str
domain:
description:
- The domain name for the cloud Autonomous VM cluster.
returned: on success
sample: domain_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
hostname:
description:
- The hostname for the cloud Autonomous VM cluster.
returned: on success
sample: hostname_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Cloud Autonomous VM cluster.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance run.
returned: on success
sample: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_update_history_entry_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance update history. This value is updated when a maintenance
update starts.
returned: on success
sample: ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- 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 L(dedicated Exadata infrastructure,https://docs.oracle.com/en/cloud/paas/autonomous-
database/index.html), this attribute must be null because the attribute is
already set at the Autonomous Exadata Infrastructure level. When using L(shared
Exadata infrastructure,https://docs.oracle.com/en/cloud/paas/autonomous- database/index.html),
if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the cloud Autonomous VM cluster.
returned: on success
sample: PROVISIONING
type: str
memory_per_oracle_compute_unit_in_gbs:
description:
- The amount of memory (in GBs) enabled per each OCPU core.
returned: on success
sample: 56
type: int
memory_size_in_gbs:
description:
- The memory allocated in GBs.
returned: on success
sample: 56
type: int
next_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the next maintenance run.
returned: on success
sample: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
node_count:
description:
- The number of database servers in the cloud VM cluster.
returned: on success
sample: 56
type: int
nsg_ids:
description:
- The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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 L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
**NsgIds restrictions:** - A network security group (NSG) is optional for
Autonomous Databases with private access. The nsgIds list can be empty.
returned: on success
sample: []
type: list
ocpu_count:
description:
- The number of CPU cores enabled on the cloud Autonomous VM cluster. Only 1
decimal place is allowed for the fractional part.
returned: on success
sample: 3.4
type: float
reclaimable_cpus:
description:
- 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.
returned: on success
sample: 3.4
type: float
shape:
description:
- The model name of the Exadata hardware running the cloud Autonomous VM cluster.
returned: on success
sample: shape_example
type: str
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time that the cloud Autonomous VM cluster was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The last date and time that the cloud Autonomous VM cluster was updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
total_container_databases:
description:
- The total number of Autonomous Container Databases that can be created with
the allocated local storage.
returned: on success
sample: 56
type: int
description:
- List of CloudAutonomousVmCluster resources
returned: on success
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
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
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
type: complex