oracle / oracle.oci / 4.2.0 / module / oci_database_pluggable_database_actions Perform actions on a PluggableDatabase resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_pluggable_database_actions (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Perform actions on a PluggableDatabase resource in Oracle Cloud Infrastructure
For I(action=local_clone), clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation.
For I(action=remote_clone), clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone.
For I(action=start), starts a stopped pluggable database. The `openMode` value of the pluggable database will be `READ_WRITE` upon completion.
For I(action=stop), stops a pluggable database. The `openMode` value of the pluggable database will be `MOUNTED` upon completion.
- name: Perform action local_clone on pluggable_database oci_database_pluggable_database_actions: # required cloned_pdb_name: cloned_pdb_name_example pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx" action: local_clone # optional pdb_admin_password: example-password target_tde_wallet_password: example-password should_pdb_admin_account_be_locked: true
- name: Perform action remote_clone on pluggable_database oci_database_pluggable_database_actions: # required target_container_database_id: "ocid1.targetcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx" source_container_db_admin_password: example-password cloned_pdb_name: cloned_pdb_name_example pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx" action: remote_clone # optional pdb_admin_password: example-password target_tde_wallet_password: example-password should_pdb_admin_account_be_locked: true
- name: Perform action start on pluggable_database oci_database_pluggable_database_actions: # required pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx" action: start
- name: Perform action stop on pluggable_database oci_database_pluggable_database_actions: # required pluggable_database_id: "ocid1.pluggabledatabase.oc1..xxxxxxEXAMPLExxxxxx" action: stop
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool action: choices: - local_clone - remote_clone - start - stop description: - The action to perform on the PluggableDatabase. required: true 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 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 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 cloned_pdb_name: description: - The name for the pluggable database (PDB). The name is unique in the context of a L(container database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. - Required for I(action=local_clone), I(action=remote_clone). 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 pdb_admin_password: description: - 'A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.' - Applicable only for I(action=local_clone)I(action=remote_clone). 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 pluggable_database_id: aliases: - id description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true 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 target_tde_wallet_password: description: - The existing TDE wallet password of the target CDB. - Applicable only for I(action=local_clone)I(action=remote_clone). type: str target_container_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the target CDB - Required for I(action=remote_clone). type: str should_pdb_admin_account_be_locked: description: - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it. - Applicable only for I(action=local_clone)I(action=remote_clone). type: bool source_container_db_admin_password: description: - The DB system administrator password of the source CDB. - Required for I(action=remote_clone). type: str
pluggable_database: 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 connection_strings: contains: all_connection_strings: description: - All connection strings to use to connect to the pluggable database. returned: on success sample: {} type: dict pdb_default: description: - A host name-based PDB connection string. returned: on success sample: pdb_default_example type: str pdb_ip_default: description: - An IP-based PDB connection string. returned: on success sample: pdb_ip_default_example type: str description: - '' returned: on success type: complex container_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the CDB. returned: on success sample: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: Operations: CostCenter: US type: dict freeform_tags: description: - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the pluggable database. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_restricted: description: - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. returned: on success sample: true type: bool lifecycle_details: description: - Detailed message for the lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the pluggable database. returned: on success sample: PROVISIONING type: str open_mode: description: - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). returned: on success sample: READ_ONLY type: str pdb_name: description: - The name for the pluggable database (PDB). The name is unique in the context of a L(container database,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. returned: on success sample: pdb_name_example type: str time_created: description: - The date and time the pluggable database was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the PluggableDatabase resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx connection_strings: all_connection_strings: {} pdb_default: pdb_default_example pdb_ip_default: pdb_ip_default_example container_database_id: ocid1.containerdatabase.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_restricted: true lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING open_mode: READ_ONLY pdb_name: pdb_name_example time_created: '2013-10-20T19:20:30+01:00' type: complex