oracle.oci.oci_database_db_system_shape_facts – Fetches details about one or multiple DbSystemShape resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

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
The name of the Availability Domain.
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 / required
The compartment OCID.
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.
name
string
Use name along with the other options to return only resources that match the given name 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.
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: List db_system_shapes
  oci_database_db_system_shape_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    availability_domain: Uocm:PHX-AD-1

Return Values

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

Key Returned Description
db_system_shapes
complex
on success
List of DbSystemShape resources

Sample:
[{'available_core_count': 56, 'available_core_count_per_node': 56, 'available_data_storage_in_t_bs': 56, 'available_data_storage_per_server_in_tbs': 1.2, 'available_db_node_per_node_in_gbs': 56, 'available_db_node_storage_in_g_bs': 56, 'available_memory_in_gbs': 56, 'available_memory_per_node_in_gbs': 56, 'core_count_increment': 56, 'max_storage_count': 56, 'maximum_node_count': 56, 'min_core_count_per_node': 56, 'min_data_storage_in_t_bs': 56, 'min_db_node_storage_per_node_in_g_bs': 56, 'min_memory_per_node_in_g_bs': 56, 'min_storage_count': 56, 'minimum_core_count': 56, 'minimum_node_count': 56, 'name': 'name_example', 'shape': 'shape_example', 'shape_family': 'shape_family_example', 'shape_type': 'AMD'}]
 
available_core_count
integer
on success
The maximum number of CPU cores that can be enabled on the DB system for this shape.

Sample:
56
 
available_core_count_per_node
integer
on success
The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.

Sample:
56
 
available_data_storage_in_t_bs
integer
on success
The maximum DATA storage that can be enabled for this shape.

Sample:
56
 
available_data_storage_per_server_in_tbs
float
on success
The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.

Sample:
1.2
 
available_db_node_per_node_in_gbs
integer
on success
The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.

Sample:
56
 
available_db_node_storage_in_g_bs
integer
on success
The maximum Db Node storage that can be enabled for this shape.

Sample:
56
 
available_memory_in_gbs
integer
on success
The maximum memory that can be enabled for this shape.

Sample:
56
 
available_memory_per_node_in_gbs
integer
on success
The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.

Sample:
56
 
core_count_increment
integer
on success
The discrete number by which the CPU core count for this shape can be increased or decreased.

Sample:
56
 
max_storage_count
integer
on success
The maximum number of Exadata storage servers available for the Exadata infrastructure.

Sample:
56
 
maximum_node_count
integer
on success
The maximum number of compute servers available for this shape.

Sample:
56
 
min_core_count_per_node
integer
on success
The minimum number of CPU cores that can be enabled per node for this shape.

Sample:
56
 
min_data_storage_in_t_bs
integer
on success
The minimum data storage that need be allocated for this shape.

Sample:
56
 
min_db_node_storage_per_node_in_g_bs
integer
on success
The minimum Db Node storage that need be allocated per node for this shape.

Sample:
56
 
min_memory_per_node_in_g_bs
integer
on success
The minimum memory that need be allocated per node for this shape.

Sample:
56
 
min_storage_count
integer
on success
The minimum number of Exadata storage servers available for the Exadata infrastructure.

Sample:
56
 
minimum_core_count
integer
on success
The minimum number of CPU cores that can be enabled on the DB system for this shape.

Sample:
56
 
minimum_node_count
integer
on success
The minimum number of compute servers available for this shape.

Sample:
56
 
name
string
on success
The name of the shape used for the DB system.

Sample:
name_example
 
shape
string
on success
Deprecated. Use `name` instead of `shape`.

Sample:
shape_example
 
shape_family
string
on success
The family of the shape used for the DB system.

Sample:
shape_family_example
 
shape_type
string
on success
The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are `AMD` , `INTEL` or `INTEL_FLEX_X9`.

Sample:
AMD


Authors

  • Oracle (@oracle)