oracle.oci.oci_database_management_external_exadata_infrastructure – Manage an ExternalExadataInfrastructure resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an ExternalExadataInfrastructure resource in Oracle Cloud Infrastructure

  • For state=present, creates an OCI resource for the Exadata infrastructure and enable monitoring service on the exadata infrastructure. The following resource/subresources are created: Infrastructure Storage server connectors Storage servers Storage grids

  • This resource has the following action operations in the oracle.oci.oci_database_management_external_exadata_infrastructure_actions module: change_compartment, disable_external_exadata_infrastructure_management, discover, enable_external_exadata_infrastructure_management.

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
  • security_token
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.
compartment_id
string
The OCID of compartment.
Required for create using state=present, update using state=present with external_exadata_infrastructure_id present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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_ids
list / elements=string
The list of all the rac database system OCIDs.
Required for create using state=present.
This parameter is updatable.
discovery_key
string
The unique key of the discovery request.
This parameter is updatable.
display_name
string
The name of the Exadata infrastructure.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
external_exadata_infrastructure_id
string
The OCID of the Exadata infrastructure.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
license_model
string
    Choices:
  • LICENSE_INCLUDED
  • BRING_YOUR_OWN_LICENSE
The Oracle license model that applies to the database management resources.
This parameter is updatable.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
state
string
    Choices:
  • present ←
  • absent
The state of the ExternalExadataInfrastructure.
Use state=present to create or update an ExternalExadataInfrastructure.
Use state=absent to delete an ExternalExadataInfrastructure.
storage_server_names
list / elements=string
The list of all the storage server names to be included for monitoering purpose. If not specified, all the storage servers associated with the database systems are included.
This parameter is updatable.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create external_exadata_infrastructure
  oci_database_management_external_exadata_infrastructure:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    db_system_ids: [ "db_system_ids_example" ]

    # optional
    discovery_key: discovery_key_example
    license_model: LICENSE_INCLUDED
    storage_server_names: [ "storage_server_names_example" ]

- name: Update external_exadata_infrastructure
  oci_database_management_external_exadata_infrastructure:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    external_exadata_infrastructure_id: "ocid1.externalexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    discovery_key: discovery_key_example
    license_model: LICENSE_INCLUDED
    display_name: display_name_example
    db_system_ids: [ "db_system_ids_example" ]
    storage_server_names: [ "storage_server_names_example" ]

- name: Update external_exadata_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_management_external_exadata_infrastructure:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    discovery_key: discovery_key_example
    license_model: LICENSE_INCLUDED
    db_system_ids: [ "db_system_ids_example" ]
    storage_server_names: [ "storage_server_names_example" ]

- name: Delete external_exadata_infrastructure
  oci_database_management_external_exadata_infrastructure:
    # required
    external_exadata_infrastructure_id: "ocid1.externalexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete external_exadata_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_management_external_exadata_infrastructure:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
external_exadata_infrastructure
complex
on success
Details of the ExternalExadataInfrastructure resource acted upon by the current operation

Sample:
{'additional_details': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_compartments': [], 'database_systems': [{'additional_details': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'status': 'status_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}], 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'rack_size': 'FULL', 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'status': 'status_example', 'storage_grid': {'additional_details': {}, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'server_count': 10, 'status': 'status_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}
 
additional_details
dictionary
on success
The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
 
compartment_id
string
on success
The OCID of compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_compartments
list / elements=string
on success
The list of OCIDs] of the compartments
 
database_systems
complex
on success
A list of database systems.
   
additional_details
dictionary
on success
The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
   
compartment_id
string
on success
The OCID of compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
The name of the resource. English letters, numbers, "-", "_" and "." only.

Sample:
display_name_example
   
id
string
on success
The OCID of the Exadata resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
internal_id
string
on success
The internal ID.

Sample:
ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
   
license_model
string
on success
The Oracle license model that applies to the database management resources.

Sample:
LICENSE_INCLUDED
   
lifecycle_details
string
on success
The details of the lifecycle state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current lifecycle state of the database resource.

Sample:
CREATING
   
resource_type
string
on success
The type of resource.

Sample:
INFRASTRUCTURE_SUMMARY
   
status
string
on success
The status of the entity.

Sample:
status_example
   
time_created
string
on success
The timestamp of the creation.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The timestamp of the last update.

Sample:
2013-10-20T19:20:30+01:00
   
version
string
on success
The version of the resource.

Sample:
version_example
 
display_name
string
on success
The name of the resource. English letters, numbers, "-", "_" and "." only.

Sample:
display_name_example
 
id
string
on success
The OCID of the Exadata resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
internal_id
string
on success
The internal ID.

Sample:
ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
 
license_model
string
on success
The Oracle license model that applies to the database management resources.

Sample:
LICENSE_INCLUDED
 
lifecycle_details
string
on success
The details of the lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current lifecycle state of the database resource.

Sample:
CREATING
 
rack_size
string
on success
The rack size of the Exadata infrastructure.

Sample:
FULL
 
resource_type
string
on success
The type of resource.

Sample:
INFRASTRUCTURE_SUMMARY
 
status
string
on success
The status of the entity.

Sample:
status_example
 
storage_grid
complex
on success

   
additional_details
dictionary
on success
The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
   
display_name
string
on success
The name of the resource. English letters, numbers, "-", "_" and "." only.

Sample:
display_name_example
   
id
string
on success
The OCID of the Exadata resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
internal_id
string
on success
The internal ID.

Sample:
ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
   
lifecycle_details
string
on success
The details of the lifecycle state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current lifecycle state of the database resource.

Sample:
CREATING
   
resource_type
string
on success
The type of resource.

Sample:
INFRASTRUCTURE_SUMMARY
   
server_count
float
on success
The number of the storage servers in the Exadata infrastructure.

Sample:
10
   
status
string
on success
The status of the entity.

Sample:
status_example
   
time_created
string
on success
The timestamp of the creation.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The timestamp of the last update.

Sample:
2013-10-20T19:20:30+01:00
   
version
string
on success
The version of the resource.

Sample:
version_example
 
time_created
string
on success
The timestamp of the creation.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The timestamp of the last update.

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
The version of the resource.

Sample:
version_example


Authors

  • Oracle (@oracle)