oracle / oracle.oci / 5.0.0 / module / oci_database_management_external_db_system Manage an ExternalDbSystem 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_db_system (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to create, update and delete an ExternalDbSystem resource in Oracle Cloud Infrastructure
For I(state=present), creates an external DB system and its related resources.
This resource has the following action operations in the M(oracle.oci.oci_database_management_external_db_system_actions) module: change_compartment, disable_external_db_system_database_management, enable_external_db_system_database_management.
- name: Create external_db_system oci_database_management_external_db_system: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" db_system_discovery_id: "ocid1.dbsystemdiscovery.oc1..xxxxxxEXAMPLExxxxxx" # optional database_management_config: # required license_model: LICENSE_INCLUDED display_name: display_name_example
- name: Update external_db_system oci_database_management_external_db_system: # required external_db_system_id: "ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: display_name_example
- name: Update external_db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_management_external_db_system: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example
- name: Delete external_db_system oci_database_management_external_db_system: # required external_db_system_id: "ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete external_db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_management_external_db_system: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example 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 ExternalDbSystem. - Use I(state=present) to create or update an ExternalDbSystem. - Use I(state=absent) to delete an ExternalDbSystem. 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 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 display_name: aliases: - name description: - The user-friendly name for the DB system. The name does not have to be unique. - Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. 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 in which the external DB system resides. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. 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 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 external_db_system_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str db_system_discovery_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the DB system discovery. - Required for create using I(state=present). 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 database_management_config: description: - '' suboptions: license_model: choices: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE description: - The Oracle license model that applies to the external database. required: true type: str type: dict 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_db_system: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str database_management_config: contains: license_model: description: - The Oracle license model that applies to the external database. returned: on success sample: LICENSE_INCLUDED type: str description: - '' returned: on success type: complex db_system_discovery_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the DB system discovery. returned: on success sample: ocid1.dbsystemdiscovery.oc1..xxxxxxEXAMPLExxxxxx type: str discovery_agent_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management agent used during the discovery of the DB system. returned: on success sample: ocid1.discoveryagent.oc1..xxxxxxEXAMPLExxxxxx type: str display_name: description: - The user-friendly name for the DB system. The name does not have to be unique. returned: on success sample: display_name_example type: str home_directory: description: - The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system. returned: on success sample: home_directory_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_cluster: description: - Indicates whether the DB system is a cluster DB system or not. returned: on success sample: true type: bool lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current lifecycle state of the external DB system resource. returned: on success sample: CREATING type: str time_created: description: - The date and time the external DB system was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The date and time the external DB system was last updated. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the ExternalDbSystem resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx database_management_config: license_model: LICENSE_INCLUDED db_system_discovery_id: ocid1.dbsystemdiscovery.oc1..xxxxxxEXAMPLExxxxxx discovery_agent_id: ocid1.discoveryagent.oc1..xxxxxxEXAMPLExxxxxx display_name: display_name_example home_directory: home_directory_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_cluster: true lifecycle_details: lifecycle_details_example lifecycle_state: CREATING time_created: '2013-10-20T19:20:30+01:00' time_updated: '2013-10-20T19:20:30+01:00' type: complex