Try SpotterFetches details about one or multiple DbSystemShape 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:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches 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.
- 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
name:
description: Use I(name) along with the other options to return only resources that
match the given name exactly.
type: str
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
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
- security_token
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
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
compartment_id:
description:
- The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
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:
- The name of the Availability Domain.
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
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
db_system_shapes:
contains:
available_core_count:
description:
- The maximum number of CPU cores that can be enabled on the DB system for this
shape.
returned: on success
sample: 56
type: int
available_core_count_per_node:
description:
- The maximum number of CPU cores per database node that can be enabled for
this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes
and VM Flex shapes.
returned: on success
sample: 56
type: int
available_data_storage_in_t_bs:
description:
- The maximum DATA storage that can be enabled for this shape.
returned: on success
sample: 56
type: int
available_data_storage_per_server_in_tbs:
description:
- The maximum data storage available per storage server for this shape. Only
applicable to ExaCC Elastic shapes.
returned: on success
sample: 1.2
type: float
available_db_node_per_node_in_gbs:
description:
- The maximum Db Node storage available per database node for this shape. Only
applicable to ExaCC Elastic shapes.
returned: on success
sample: 56
type: int
available_db_node_storage_in_g_bs:
description:
- The maximum Db Node storage that can be enabled for this shape.
returned: on success
sample: 56
type: int
available_memory_in_gbs:
description:
- The maximum memory that can be enabled for this shape.
returned: on success
sample: 56
type: int
available_memory_per_node_in_gbs:
description:
- The maximum memory available per database node for this shape. Only applicable
to ExaCC Elastic shapes.
returned: on success
sample: 56
type: int
core_count_increment:
description:
- The discrete number by which the CPU core count for this shape can be increased
or decreased.
returned: on success
sample: 56
type: int
max_storage_count:
description:
- The maximum number of Exadata storage servers available for the Exadata infrastructure.
returned: on success
sample: 56
type: int
maximum_node_count:
description:
- The maximum number of compute servers available for this shape.
returned: on success
sample: 56
type: int
min_core_count_per_node:
description:
- The minimum number of CPU cores that can be enabled per node for this shape.
returned: on success
sample: 56
type: int
min_data_storage_in_t_bs:
description:
- The minimum data storage that need be allocated for this shape.
returned: on success
sample: 56
type: int
min_db_node_storage_per_node_in_g_bs:
description:
- The minimum Db Node storage that need be allocated per node for this shape.
returned: on success
sample: 56
type: int
min_memory_per_node_in_g_bs:
description:
- The minimum memory that need be allocated per node for this shape.
returned: on success
sample: 56
type: int
min_storage_count:
description:
- The minimum number of Exadata storage servers available for the Exadata infrastructure.
returned: on success
sample: 56
type: int
minimum_core_count:
description:
- The minimum number of CPU cores that can be enabled on the DB system for this
shape.
returned: on success
sample: 56
type: int
minimum_node_count:
description:
- The minimum number of compute servers available for this shape.
returned: on success
sample: 56
type: int
name:
description:
- The name of the shape used for the DB system.
returned: on success
sample: name_example
type: str
shape:
description:
- Deprecated. Use `name` instead of `shape`.
returned: on success
sample: shape_example
type: str
shape_family:
description:
- The family of the shape used for the DB system.
returned: on success
sample: shape_family_example
type: str
shape_type:
description:
- The shape type for the virtual machine DB system. Shape type is determined
by CPU hardware. Valid values are `AMD` , `INTEL`, `INTEL_FLEX_X9` or `AMPERE_FLEX_A1`.
returned: on success
sample: AMD
type: str
description:
- List of DbSystemShape resources
returned: on success
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
type: complex