oracle.oci.oci_database_management_external_exadata_storage_connector – Manage an ExternalExadataStorageConnector 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_storage_connector.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, create the storage server connector after validating the connection information. Or only validates the connection information for creating the connection to the storage server. The connector for one storage server is associated with the Exadata infrastructure discovery or existing Exadata infrastructure.

  • This resource has the following action operations in the oracle.oci.oci_database_management_external_exadata_storage_connector_actions module: check.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
agent_id
string
The OCID of the agent for the Exadata storage server.
Required for create using state=present.
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 the compartment.
Required for create using state=present.
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.
connection_uri
string
The unique connection string of the connection. For example, "https://slcm21celadm02.us.oracle.com:443/MS/RESTService/".
Required for create using state=present.
This parameter is updatable.
connector_name
string
The connector name if OCI connector is created.
Required for create using state=present.
This parameter is updatable.
credential_info
dictionary
Required for create using state=present.
This parameter is updatable.
password
string / required
The password of the user.
ssl_trust_store_location
string
The full path of the SSL trust store Location in the agent.
ssl_trust_store_password
string
The password of the SSL trust store Location in the agent.
ssl_trust_store_type
string
    Choices:
  • JKS
  • BCFKS
The SSL trust store type.
username
string / required
The name of the user.
external_exadata_infrastructure_id
string
The OCID of the Exadata infrastructure.
Required for create using state=present.
external_exadata_storage_connector_id
string
The OCID of the connector to the Exadata storage server.
Required for update using state=present.
Required for delete using state=absent.

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.
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 ExternalExadataStorageConnector.
Use state=present to create or update an ExternalExadataStorageConnector.
Use state=absent to delete an ExternalExadataStorageConnector.
storage_server_id
string
The OCID of the Exadata storage server.
Required for create using state=present.
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_storage_connector
  oci_database_management_external_exadata_storage_connector:
    # required
    storage_server_id: "ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx"
    agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
    connector_name: connector_name_example
    connection_uri: connection_uri_example
    credential_info:
      # required
      username: username_example
      password: example-password

      # optional
      ssl_trust_store_type: JKS
      ssl_trust_store_location: ssl_trust_store_location_example
      ssl_trust_store_password: example-password

- name: Update external_exadata_storage_connector
  oci_database_management_external_exadata_storage_connector:
    # required
    external_exadata_storage_connector_id: "ocid1.externalexadatastorageconnector.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    connector_name: connector_name_example
    connection_uri: connection_uri_example
    credential_info:
      # required
      username: username_example
      password: example-password

      # optional
      ssl_trust_store_type: JKS
      ssl_trust_store_location: ssl_trust_store_location_example
      ssl_trust_store_password: example-password

- name: Delete external_exadata_storage_connector
  oci_database_management_external_exadata_storage_connector:
    # required
    external_exadata_storage_connector_id: "ocid1.externalexadatastorageconnector.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
external_exadata_storage_connector
complex
on success
Details of the ExternalExadataStorageConnector resource acted upon by the current operation

Sample:
{'additional_details': {}, 'agent_id': 'ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx', 'connection_uri': 'connection_uri_example', 'display_name': 'display_name_example', 'exadata_infrastructure_id': 'ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'status': 'status_example', 'storage_server_id': 'ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx', '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"}`
 
agent_id
string
on success
The OCID of the agent for the Exadata storage server.

Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
 
connection_uri
string
on success
The unique connection string of the connection. For example, "https://slcm21celadm02.us.oracle.com:443/MS/RESTService/".

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

Sample:
display_name_example
 
exadata_infrastructure_id
string
on success
The OCID of Exadata infrastructure system.

Sample:
ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
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
 
status
string
on success
The status of the entity.

Sample:
status_example
 
storage_server_id
string
on success
The OCID of the Exadata storage server.

Sample:
ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx
 
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)