oracle / oracle.oci / 4.21.0 / module / oci_database_management_external_exadata_storage_connector Manage an ExternalExadataStorageConnector resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_external_exadata_storage_connector (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
This module allows the user to create, update and delete an ExternalExadataStorageConnector resource in Oracle Cloud Infrastructure
For I(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 M(oracle.oci.oci_database_management_external_exadata_storage_connector_actions) module: check.
- 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
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the ExternalExadataStorageConnector. - Use I(state=present) to create or update an ExternalExadataStorageConnector. - Use I(state=absent) to delete an ExternalExadataStorageConnector. required: false type: str key_by: description: 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. elements: str type: list 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 agent_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. - Required for create using I(state=present). 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 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 force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required for create using I(state=present). type: str connection_uri: description: - The unique connection string of the connection. For example, "https://slcm21celadm02.us.oracle.com:443/MS/RESTService/". - Required for create using I(state=present). - This parameter is updatable. type: str connector_name: description: - The connector name if OCI connector is created. - Required for create using I(state=present). - This parameter is updatable. type: str credential_info: description: - '' - Required for create using I(state=present). - This parameter is updatable. suboptions: password: description: - The password of the user. required: true type: str ssl_trust_store_location: description: - The full path of the SSL trust store Location in the agent. type: str ssl_trust_store_password: description: - The password of the SSL trust store Location in the agent. type: str ssl_trust_store_type: choices: - JKS - BCFKS description: - The SSL trust store type. type: str username: description: - The name of the user. required: true type: str type: dict 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 storage_server_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata storage server. - Required for create using I(state=present). 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 external_exadata_infrastructure_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. - Required for create using I(state=present). type: str external_exadata_storage_connector_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server. - Required for update using I(state=present). - Required for delete using I(state=absent). 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
external_exadata_storage_connector: contains: additional_details: description: - 'The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`' returned: on success sample: {} type: dict agent_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. returned: on success sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx type: str connection_uri: description: - The unique connection string of the connection. For example, "https://slcm21celadm02.us.oracle.com:443/MS/RESTService/". returned: on success sample: connection_uri_example type: str display_name: description: - The name of the resource. English letters, numbers, "-", "_" and "." only. returned: on success sample: display_name_example type: str exadata_infrastructure_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of Exadata infrastructure system. returned: on success sample: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata resource. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str internal_id: description: - The internal ID. returned: on success sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - The details of the lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current lifecycle state of the database resource. returned: on success sample: CREATING type: str resource_type: description: - The type of resource. returned: on success sample: INFRASTRUCTURE_SUMMARY type: str status: description: - The status of the entity. returned: on success sample: status_example type: str storage_server_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata storage server. returned: on success sample: ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx type: str time_created: description: - The timestamp of the creation. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The timestamp of the last update. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str version: description: - The version of the resource. returned: on success sample: version_example type: str description: - Details of the ExternalExadataStorageConnector resource acted upon by the current operation returned: on success 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 type: complex