oracle.oci.oci_mysql_analytics_cluster_memory_estimate_facts – Fetches details about a AnalyticsClusterMemoryEstimate resource 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_mysql_analytics_cluster_memory_estimate_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a AnalyticsClusterMemoryEstimate resource in Oracle Cloud Infrastructure

  • DEPRECATED – please use HeatWave API instead. Gets the most recent Analytics Cluster memory estimate that can be used to determine a suitable Analytics Cluster size.

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.
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.
db_system_id
string / required
The DB System OCID.

aliases: id
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.
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 analytics_cluster_memory_estimate
  oci_mysql_analytics_cluster_memory_estimate_facts:
    # required
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
analytics_cluster_memory_estimate
complex
on success
AnalyticsClusterMemoryEstimate resource

Sample:
{'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'status': 'ACCEPTED', 'table_schemas': [{'per_table_estimates': [{'analytical_footprint_in_mbs': 56, 'error_comment': 'error_comment_example', 'estimated_row_count': 56, 'table_name': 'table_name_example', 'to_load_column_count': 56, 'varlen_column_count': 56}], 'schema_name': 'schema_name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
db_system_id
string
on success
The OCID of the DB System the Analytics Cluster memory estimate is associated with.

Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
 
status
string
on success
Current status of the Work Request generating the Analytics Cluster memory estimate.

Sample:
ACCEPTED
 
table_schemas
complex
on success
Collection of schemas with estimated memory footprints for MySQL user tables of each schema when loaded to Analytics Cluster memory.

   
per_table_estimates
complex
on success
Estimated memory footprints for MySQL user tables of the schema when loaded to Analytics Cluster memory.

     
analytical_footprint_in_mbs
integer
on success
The estimated memory footprint of the table in MBs when loaded to Analytics Cluster memory (null if the table cannot be loaded to the Analytics Cluster).

Sample:
56
     
error_comment
string
on success
Error comment (empty string if no errors occured).

Sample:
error_comment_example
     
estimated_row_count
integer
on success
The estimated number of rows in the table. This number was used to derive the analytical memory footprint.

Sample:
56
     
table_name
string
on success
The table name.

Sample:
table_name_example
     
to_load_column_count
integer
on success
The number of columns to be loaded to Analytics Cluster memory. These columns contribute to the analytical memory footprint.

Sample:
56
     
varlen_column_count
integer
on success
The number of variable-length columns to be loaded to Analytics Cluster memory. These columns contribute to the analytical memory footprint.

Sample:
56
   
schema_name
string
on success
The name of the schema.

Sample:
schema_name_example
 
time_created
string
on success
The date and time that the Work Request to generate the Analytics Cluster memory estimate was issued, as described by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time that the Analytics Cluster memory estimate was generated, as described by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)