oracle / oracle.oci / 2.38.0 / module / oci_database_migration_migration_actions Perform actions on a Migration resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_migration_migration_actions (2.38.0) — module
Install with ansible-galaxy collection install oracle.oci:==2.38.0
collections: - name: oracle.oci version: 2.38.0
Perform actions on a Migration resource in Oracle Cloud Infrastructure
For I(action=change_compartment), used to change the Migration compartment.
- name: Perform action change_compartment on migration oci_database_migration_migration_actions: # required migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx" compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" action: change_compartment
action: choices: - change_compartment description: - The action to perform on the Migration. 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 migration_id: aliases: - id description: - The OCID of the migration required: true type: str compartment_id: description: - The OCID of the compartment to move the resource to. required: true 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 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
migration: contains: advisor_settings: contains: is_ignore_errors: description: - True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. returned: on success sample: true type: bool is_skip_advisor: description: - True to skip the Pre-Migration Advisor execution. Default is false. returned: on success sample: true type: bool description: - '' returned: on success type: complex agent_id: description: - The OCID of the registered on-premises ODMS Agent. Only valid for Offline Migrations. returned: on success sample: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx type: str compartment_id: description: - OCID of the compartment returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str credentials_secret_id: description: - OCID of the Secret in the OCI vault containing the Migration credentials. Used to store GoldenGate administrator user credentials. returned: on success sample: ocid1.credentialssecret.oc1..xxxxxxEXAMPLExxxxxx type: str data_transfer_medium_details: contains: database_link_details: contains: name: description: - Name of database link from OCI database to on-premise database. ODMS will create link, if the link does not already exist. returned: on success sample: name_example type: str wallet_bucket: contains: bucket_name: description: - Bucket name. returned: on success sample: bucket_name_example type: str namespace_name: description: - Namespace name of the object store bucket. returned: on success sample: namespace_name_example type: str description: - '' returned: on success type: complex description: - '' returned: on success type: complex object_storage_details: contains: bucket_name: description: - Bucket name. returned: on success sample: bucket_name_example type: str namespace_name: description: - Namespace name of the object store bucket. returned: on success sample: namespace_name_example type: str description: - '' returned: on success type: complex description: - '' returned: on success type: complex datapump_settings: contains: data_pump_parameters: contains: estimate: description: - Estimate size of dumps that will be generated. returned: on success sample: BLOCKS type: str exclude_parameters: description: - Exclude paratemers for Export and Import. returned: on success sample: [] type: list export_parallelism_degree: description: - Maximum number of worker processes that can be used for a Data Pump Export job. returned: on success sample: 56 type: int import_parallelism_degree: description: - Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property. returned: on success sample: 56 type: int is_cluster: description: - Set to false to force Data Pump worker processes to run on one instance. returned: on success sample: true type: bool table_exists_action: description: - 'IMPORT: Specifies the action to be performed when data is loaded into a preexisting table.' returned: on success sample: TRUNCATE type: str description: - '' returned: on success type: complex export_directory_object: contains: name: description: - Name of directory object in database returned: on success sample: name_example type: str path: description: - Absolute path of directory on database server returned: on success sample: path_example type: str description: - '' returned: on success type: complex import_directory_object: contains: name: description: - Name of directory object in database returned: on success sample: name_example type: str path: description: - Absolute path of directory on database server returned: on success sample: path_example type: str description: - '' returned: on success type: complex job_mode: description: - Data Pump job mode. Refer to L(Data Pump Export Modes ,https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-export- utility.html#GUID-8E497131-6B9B-4CC8-AA50-35F480CAC2C4) returned: on success sample: FULL type: str metadata_remaps: contains: new_value: description: - Specifies the new value that oldValue should be translated into. returned: on success sample: new_value_example type: str old_value: description: - Specifies the value which needs to be reset. returned: on success sample: old_value_example type: str type: description: - Type of remap. Refer to L(METADATA_REMAP Procedure ,https://docs.oracle.com/en/database/oracle/oracle- database/19/arpls/DBMS_DATAPUMP.html#GUID-0FC32790-91E6-4781-87A3-229DE024CB3D) returned: on success sample: SCHEMA type: str description: - Defines remapping to be applied to objects as they are processed. Refer to L(METADATA_REMAP Procedure ,https://docs.oracle.com/en/database/oracle/oracle- database/19/arpls/DBMS_DATAPUMP.html#GUID-0FC32790-91E6-4781-87A3-229DE024CB3D) returned: on success type: complex description: - '' returned: on success type: complex defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - Migration Display Name returned: on success sample: display_name_example type: str dump_transfer_details: contains: source: contains: kind: description: - Type of dump transfer to use during migration in source or target host. Default kind is CURL returned: on success sample: CURL type: str oci_home: description: - Path to the OCI CLI installation in the node. returned: on success sample: oci_home_example type: str description: - '' returned: on success type: complex target: contains: kind: description: - Type of dump transfer to use during migration in source or target host. Default kind is CURL returned: on success sample: CURL type: str oci_home: description: - Path to the OCI CLI installation in the node. returned: on success sample: oci_home_example type: str description: - '' returned: on success type: complex description: - '' returned: on success type: complex exclude_objects: contains: object_name: description: - Name of the object (regular expression is allowed) returned: on success sample: object_name_example type: str owner: description: - Owner of the object (regular expression is allowed) returned: on success sample: owner_example type: str type: description: - Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. returned: on success sample: type_example type: str description: - Database objects to exclude from migration. If 'includeObjects' are specified, only exclude object types can be specified with general wildcards (.*) for owner and objectName. returned: on success type: complex executing_job_id: description: - OCID of the current ODMS Job in execution for the Migration, if any. returned: on success sample: ocid1.executingjob.oc1..xxxxxxEXAMPLExxxxxx type: str freeform_tags: description: - 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`' returned: on success sample: Department: Finance type: dict golden_gate_details: contains: hub: contains: compute_id: description: - OCID of GoldenGate compute instance. returned: on success sample: ocid1.compute.oc1..xxxxxxEXAMPLExxxxxx type: str rest_admin_credentials: contains: username: description: - Administrator username returned: on success sample: username_example type: str description: - '' returned: on success type: complex source_container_db_admin_credentials: contains: username: description: - Administrator username returned: on success sample: username_example type: str description: - '' returned: on success type: complex source_db_admin_credentials: contains: username: description: - Administrator username returned: on success sample: username_example type: str description: - '' returned: on success type: complex source_microservices_deployment_name: description: - Name of GoldenGate deployment to operate on source database returned: on success sample: source_microservices_deployment_name_example type: str target_db_admin_credentials: contains: username: description: - Administrator username returned: on success sample: username_example type: str description: - '' returned: on success type: complex target_microservices_deployment_name: description: - Name of GoldenGate deployment to operate on target database returned: on success sample: target_microservices_deployment_name_example type: str url: description: - Oracle GoldenGate hub's REST endpoint. Refer to https://docs.oracle.com/en/middleware/goldengate/core/19.1/securing/network.html#GUID-A709DA55-111D-455E-8942-C9BDD1E38CAA returned: on success sample: url_example type: str description: - '' returned: on success type: complex settings: contains: acceptable_lag: description: - ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. returned: on success sample: 56 type: int extract: contains: long_trans_duration: description: - Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. returned: on success sample: 56 type: int performance_profile: description: - Extract performance. returned: on success sample: LOW type: str description: - '' returned: on success type: complex replicat: contains: map_parallelism: description: - Number of threads used to read trail files (valid for Parallel Replicat) returned: on success sample: 56 type: int max_apply_parallelism: description: - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat) returned: on success sample: 56 type: int min_apply_parallelism: description: - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat) returned: on success sample: 56 type: int description: - '' returned: on success type: complex description: - '' returned: on success type: complex description: - '' returned: on success type: complex id: description: - The OCID of the resource returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str include_objects: contains: object_name: description: - Name of the object (regular expression is allowed) returned: on success sample: object_name_example type: str owner: description: - Owner of the object (regular expression is allowed) returned: on success sample: owner_example type: str type: description: - Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. returned: on success sample: type_example type: str description: - Database objects to include from migration. returned: on success type: complex lifecycle_details: description: - Additional status related to the execution and current state of the Migration. returned: on success sample: READY type: str lifecycle_state: description: - The current state of the Migration resource. returned: on success sample: CREATING type: str source_container_database_connection_id: description: - The OCID of the Source Container Database Connection. returned: on success sample: ocid1.sourcecontainerdatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx type: str source_database_connection_id: description: - The OCID of the Source Database Connection. returned: on success sample: ocid1.sourcedatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx type: str system_tags: description: - 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' returned: on success sample: {} type: dict target_database_connection_id: description: - The OCID of the Target Database Connection. returned: on success sample: ocid1.targetdatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx type: str time_created: description: - The time the Migration was created. An RFC3339 formatted datetime string. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_last_migration: description: - The time of last Migration. An RFC3339 formatted datetime string. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The time of the last Migration details update. An RFC3339 formatted datetime string. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - Migration type. returned: on success sample: ONLINE type: str vault_details: contains: compartment_id: description: - OCID of the compartment where the secret containing the credentials will be created. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str key_id: description: - OCID of the vault encryption key returned: on success sample: ocid1.key.oc1..xxxxxxEXAMPLExxxxxx type: str vault_id: description: - OCID of the vault returned: on success sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx type: str description: - '' returned: on success type: complex wait_after: description: - Name of a migration phase. The Job will wait after executing this phase until the Resume Job endpoint is called. returned: on success sample: ODMS_VALIDATE_TGT type: str description: - Details of the Migration resource acted upon by the current operation returned: on success sample: advisor_settings: is_ignore_errors: true is_skip_advisor: true agent_id: ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx credentials_secret_id: ocid1.credentialssecret.oc1..xxxxxxEXAMPLExxxxxx data_transfer_medium_details: database_link_details: name: name_example wallet_bucket: bucket_name: bucket_name_example namespace_name: namespace_name_example object_storage_details: bucket_name: bucket_name_example namespace_name: namespace_name_example datapump_settings: data_pump_parameters: estimate: BLOCKS exclude_parameters: [] export_parallelism_degree: 56 import_parallelism_degree: 56 is_cluster: true table_exists_action: TRUNCATE export_directory_object: name: name_example path: path_example import_directory_object: name: name_example path: path_example job_mode: FULL metadata_remaps: - new_value: new_value_example old_value: old_value_example type: SCHEMA defined_tags: Operations: CostCenter: US display_name: display_name_example dump_transfer_details: source: kind: CURL oci_home: oci_home_example target: kind: CURL oci_home: oci_home_example exclude_objects: - object_name: object_name_example owner: owner_example type: type_example executing_job_id: ocid1.executingjob.oc1..xxxxxxEXAMPLExxxxxx freeform_tags: Department: Finance golden_gate_details: hub: compute_id: ocid1.compute.oc1..xxxxxxEXAMPLExxxxxx rest_admin_credentials: username: username_example source_container_db_admin_credentials: username: username_example source_db_admin_credentials: username: username_example source_microservices_deployment_name: source_microservices_deployment_name_example target_db_admin_credentials: username: username_example target_microservices_deployment_name: target_microservices_deployment_name_example url: url_example settings: acceptable_lag: 56 extract: long_trans_duration: 56 performance_profile: LOW replicat: map_parallelism: 56 max_apply_parallelism: 56 min_apply_parallelism: 56 id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx include_objects: - object_name: object_name_example owner: owner_example type: type_example lifecycle_details: READY lifecycle_state: CREATING source_container_database_connection_id: ocid1.sourcecontainerdatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx source_database_connection_id: ocid1.sourcedatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx system_tags: {} target_database_connection_id: ocid1.targetdatabaseconnection.oc1..xxxxxxEXAMPLExxxxxx time_created: '2013-10-20T19:20:30+01:00' time_last_migration: '2013-10-20T19:20:30+01:00' time_updated: '2013-10-20T19:20:30+01:00' type: ONLINE vault_details: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx key_id: ocid1.key.oc1..xxxxxxEXAMPLExxxxxx vault_id: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx wait_after: ODMS_VALIDATE_TGT type: complex