Which two migration methodologies can you use for migrating on-premises databases to autonomous database with Oracle zero downtime migration?

Zero Downtime Migration permissions and ownership of files and directories, and handling of configurations for security features, are equivalent to those of Oracle Database.

Zero Downtime Migration installs in a location, named ZDM_HOME, that is structured similarly to the Oracle home directory, ORACLE_HOME, for Oracle Database. The permissions and ownership of files and directories in the ZDM_HOME follow the same conventions as that of a database ORACLE_HOME.

Zero Downtime Migration also creates a base directory structure for storing Zero Downtime Migration configuration files, logs, and other artifacts, named ZDM_BASE, that is similar to an Oracle base directory, ORACLE_BASE, that is associated with an Oracle home. The structure, owners, and permissions of directories and files in ZDM_BASE are similar to that of an ORACLE_BASE.

ZDM_BASE and ORACLE_BASE do not allow access by group or others.

You do not need to do any additional steps to ensure security the of the Zero Downtime Migration configuration because the Zero Downtime Migration configuration is designed to be secure out of the box.

Zero Downtime Migration is configured to accept JMX connections only from the local host, and to listen on the loopback address for HTTP connections. Zero Downtime Migration operations can only be performed by the operating system user that installed the product.

For physical migrations, SSH connectivity from the Zero Downtime Migration service host to the source database server and the target database server is required. You must provide the SSH key file location as an input for a migration job, and the existence of this file is expected for the duration of the migration job. You must manage the security of the directories and files where these key files are located.

You can modify the communication ports when there is a port conflict with another application. Note that access to these ports are configured only from within the Zero Downtime Migration host. You can change the RMI and HTTP port properties in the file $ZDM_BASE/crsdata/zdm_service_host/rhp/conf/standalone_config.properties.

The properties are:

  • RMI port - oracle.jwc.rmi.port=8897
  • HTTP port - oracle.jwc.http.port=8898

Restart the Zero Downtime Migration service after changing the properties.

When Zero Downtime Migration operations require passwords, prompts are given for password entry by default. Zero Downtime Migration can also operate non-interactively by entering wallet information in the migration response file settings.

Passwords are encrypted and stored in the Zero Downtime Migration database. Provided passwords are not expected to change for the duration of a migration job.

From an operation perspective, Zero Downtime Migration follows the guidelines in Oracle Database Security Guide for handling source and target database configurations for migration, such as Oracle Wallets, Transparent Data Encryption, and so on.


Page 2

If a host has not had Zero Downtime Migration software installed on it previously, verify that it complies with the requirements and perform any pre-installation tasks, then download and install the software. Once the software is installed, the host is referred to as the Zero Downtime Migration service host.

Provision a host with the following prerequisites and complete the following pre-installation tasks before installing Zero Downtime Migration software on it.

  • The Zero Downtime Migration service host should be a dedicated system, but it can be shared for other purposes.

    However, if the Zero Downtime Migration service is installed on the same host where RHP server is deployed, see Running RHP and Zero Downtime Migration Service on the Same Host for more info.

  • Zero Downtime Migration software requires a standalone Linux host running Oracle Linux 7.

  • The Zero Downtime Migration service host requires Perl to run the install script.

    Also, if you plan to migrate from Oracle Database 11.2.0.4 sources, you also need the latest Perl patch 5.28.2.

  • The Zero Downtime Migration service host must be able to connect to the source and the target database servers.

  • Ensure that the Linux host has 100 GB of free storage space.

  • You may use an existing user, or, on the Zero Downtime Migration service host, as root user, create a zdm group and add zdmuser user to the group.

    For example,

    root> groupadd zdm root> useradd –g zdm zdmuser
  • Verify that the glibc-devel and expect packages are installed.

    For Oracle Linux 7 installations with Base Environment "Minimal Install" you also need to install the packages unzip libaio oraclelinux-developer-release-el7.

  • Verify that the /etc/hosts entry for the host name and IP address are configured as expected, so that the host selected for Zero Downtime Migration software installation resolves to the correct IP address and the IP address is reachable with ping.

  • During the installation, the script might report any missing packages and instructions for setting appropriate values for kernel parameters. Be sure to install the missing packages and set the kernel parameters before the Zero Downtime Migration software installation.

  • Optionally, set a ZDM_HOME environment variable to the absolute path of the directory where the Zero Downtime Migration software will be installed. All of the examples in this document use $ZDM_HOME.

    zdmuser> export ZDM_HOME=absolute_path_to_zdm_home


Page 3

Host * ServerAliveInterval 10 ServerAliveCountMax 2 Host OCI_server_name HostName OCI_server_IP_address IdentityFile Private_key_file_location User OCI_user_login ProxyCommand /usr/bin/nc -X connect -x proxy_name:proxy_port %h %p

Where

  • OCI_server_name is the Oracle Cloud Infrastructure target database server name without the domain name. For an Oracle RAC database use the first Oracle RAC server name without the domain name.
  • OCI_server_IP_address is the Oracle Cloud Infrastructure target database server IP address. For an Oracle RAC database use the first Oracle RAC server IP address.
  • Private_key_file_location is the location of the private key file on the source database server, which you copied from the target database server in step 3 above.
  • OCI_user_login is the OS user used to access the target database servers.
  • proxy_name is the host name of the proxy server.
  • proxy_port is the port of the proxy server.

Note that the proxy setup might not be required when you are not using a proxy server for connectivity. For example, when the source database server is on Oracle Cloud Infrastructure Classic, you can remove or comment the line starting with ProxyCommand.

For example, after specifying the relevant values, the /root/.ssh/config file should be similar to the following.

Host * ServerAliveInterval 10 ServerAliveCountMax 2 Host ocidb1 HostName 192.0.2.1 IdentityFile /root/.ssh/ocidb1.ppk User opc ProxyCommand /usr/bin/nc -X connect -x www-proxy.example.com:80 %h %p

The file permissions should be similar to the following.

/root/.ssh>ls -l config -rw------- 1 root root 1679 Oct 16 10:05 config

In the above example, the Oracle Cloud Infrastructure server name is ocidb1, and the Oracle Cloud Infrastructure server public IP address is 192.0.2.1.

If the source is an Oracle Cloud Infrastructure Classic server, the proxy_name is not required, so you can remove or comment the line starting with ProxyCommand.

If the source is an Oracle RAC database, then copy the same /root/.ssh/config file onto all of the source Oracle RAC database servers. This file will have the Oracle Cloud Infrastructure server name, Oracle Cloud Infrastructure server public IP address, and private key file location of first Oracle Cloud Infrastructure Oracle RAC server information configured.


Page 4

The Zero Downtime Migration physical migration process involves creating a backup of the source database and restoring it to the target database, or using and existing backup.

Oracle Cloud Infrastructure Object Storage

OCI Object Storage is supported as a backup medium when migrating a database to Oracle Cloud Infrastructure, Exadata Cloud Service, or any on-premises Exadata Cloud at Customer target.

Zero Downtime Migration service either initiates the source database backup as part of the migration work flow, or you can specify an existing backup already in the Object Storage bucket, and Zero Downtime Migration restores it to the target environment, so Object Storage must be accessible from both the source and target environments.

The source database is backed up to the specified container and restored to the target using RMAN SQL*Net connectivity.

The Zero Downtime Migration service host uses an SSH connection to the source and target database servers to install and configure the backup module software necessary to back up to and restore from Object Storage. The backup from the source database to Object Storage takes place over an RMAN channel.

Make sure that the Object Storage bucket is created using the Oracle Cloud Service Console as appropriate.

Also, make sure adequate storage is provisioned and available on the object store to accommodate the source database backup.

Zero Data Loss Recovery Appliance

Zero Data Loss Recovery Appliance is supported as a backup medium for migrating a database to an Exadata Cloud at Customer target or an Oracle Exadata Database Machine.

If Zero Data Loss Recovery Appliance is chosen as backup medium, then you must ensure that the Zero Data Loss Recovery Appliance has a valid backup of the source database, because Zero Downtime Migration does not initiate a backup to Zero Data Loss Recovery Appliance as part of the work flow.

You must also ensure that all instances of the database are up before initiating a backup to Zero Data Loss Recovery Appliance. The duplicate database operation might fail if the backup is initiated when an instance is down.

The Zero Downtime Migration service accesses the backup in Zero Data Loss Recovery Appliance and restores it to Exadata Cloud at Customer. The Zero Data Loss Recovery Appliance access credentials and wallet location are mandatory input parameters, so that Zero Downtime Migration can handle the Zero Data Loss Recovery Appliance wallet setup at the target database.

Any transfer of redo stream between the source and the target database server, in either direction, takes place over a SQL*Net link.

Refer to the Zero Data Loss Recovery Appliance documentation for information about creating backups.

Network File System (NFS)

NFS is supported as a backup medium when migrating a database to an Exadata Cloud at Customer target, or any on-premises Oracle Exadata Database Machine target.

If you choose to back up the database to an NFS mount, then the Zero Downtime Migration service initiates the source database backup (or you can specify a pre-existing backup) and restores it to the Exadata target environment. The NFS should be accessible from both the source and target environments.

The source database is backed up to the specified path and restored to Exadata Cloud at Customer using RMAN SQL*Net connectivity.

When you perform a migration using offline migration through NFS, SQL*Net connectivity between the source and target are not needed.


Page 5

In Zero Downtime Migration, you can specify objects to include or exclude from a logical migration job using parameters in the response file.

Specify rules for objects to include or exclude in a migration job using the EXLCUDEOBJECTS-n and INCLUDEOBJECTS-n response file parameters.

You can either include or exclude objects in a migration, but you cannot do both.

If no rule is defined, all schemas and objects of the source database will be migrated, with exceptions listed in What Is Migrated During Initial Load.

If you specify Include rules, the migration will only move the specified objects and their dependent objects; all other objects are automatically excluded. USER and TABLESPACE_QUOTA objectType associated with included schema are included by default.

When specifying Exclude rules, the migration will exclude the specified objects and their dependent objects; all other objects are included in the migration.

You can define multiple include or exclude rules by incrementing the integer appended to the parameter name, as shown in these examples.

Example of a single include rule:

INCLUDEOBJECTS-1=owner:ownerValue1, objectName:objectNameValue1, objectType:objectTypeValue1

Example of two exclude rules:

EXCLUDEOBJECTS-1=owner:ownerValue1, objectName:objectNameValue1, objectType:objectTypeValue1

EXCLUDEOBJECTS-2=owner:ownerValue2, objectName:objectNameValue2, objectType:objectTypeValue2

Required Parameter Fields

To specify INCLUDEOBJECTS-n and EXLCUDEOBJECTS-n response file parameters, enter values for each of the following fields:

  • owner specifies the owner of the selected database objects. When using Include rules, all rules must be for the same owner, and wild characters are not allowed.

  • objectName specifies the name of selected database objects

  • objectType specifies the type of selected database objects. You can select ALL to select objects of all types (default).

You can filter owner and objectName fields using any valid pattern in Java class Pattern. For example, you can enter .* in the objectName field to select objects of any name.

Supported objectTypes for object-level filtering

objectName can be chosen or can be .*

DIRECTORY

FUNCTION

JOB

MATERIALIZED_VIEW

PACKAGE

PROCEDURE

TRIGGER

SEQUENCE

TABLE

Supported objectTypes for generic objectType-level exclude or include

(objectName must be .*)

CLUSTER

DB_LINK

GRANT

OBJECT_GRANT

SYSTEM_GRANT

ROLE_GRANT

PROCOBJ_GRANT

PROCDEPOBJ_GRANT

INDEX

INDEXTYPE

MATERIALIZED_VIEW_LOG

MATERIALIZED_ZONEMAP

POST_TABLE_ACTION

PROCOBJ

PROFILE

REF_CONSTRAINT

RLS_POLICY

SYNONYM

TABLESPACE

TABLESPACE_QUOTA

USER

XMLSCHEMA

VIEW

Example 5-1 Include all objects of schema MySchema

INCLUDEOBJECTS-1=owner:MySchema, objectName:.*, objectType:ALL

owner objectName objectType
MySchema .* ALL

Example 5-2 Include all tables starting with PROD and procedure MYPROC of schema MySchema, including all dependent objects

INCLUDEOBJECTS-1=owner:MySchema, objectName:PROD.*, objectType:TABLE

INCLUDEOBJECTS-2=owner:MySchema, objectName:MYPROC, objectType:PROCEDURE

owner objectName objectType
MySchema PROD.* TABLE
MySchema MYPROC PROCEDURE

Example 5-3 Exclude schemas starting with Experimental, the table MySchema.OldTable (also excluding all dependent objects) and all objects of type DB_LINK

Note that MySchema.OldTable will not be excluded if a table called OldTable is present in a different schema that is also migrated.

EXCLUDEOBJECTS-1=owner:Experimental.*, objectName:.*, objectType:ALL

EXCLUDEOBJECTS-2=owner:MySchema, objectName:OldTable, objectType:TABLE

EXCLUDEOBJECTS-3=owner:.*, objectName:.*, objectType:DB_LINK

owner objectName objectType
Experimental.* .* ALL
MySchema OldTable TABLE
.* .* DB_LINK

Specify Included and Excluded Objects with Special Characters

The following examples show you how to specify objects names that use special characters in the EXCLUDEOBJECTS and INCLUDEOBJECTS parameters.

  • To escape a special character, use two slashes (//) before and after all characters in the string before the special character.

    For example, to escape dollar sign ($):

    \\INLUDEOBJECTS-3= owner:GRAF_MULTI\\$_HR

  • To match all characters in between prefix and suffix pattern, add a period and an asterisk (.*) where the matching should occur.

    For example, to exclude all schemas starting with GRAF and ending with HR:

    EXCLUDEOBJECTS-3= owner:GRAF.*HR

Migrating Tables with support_mode = INTERNAL

Zero Downtime Migration detects and notifies you about tables with support_mode = INTERNAL.

DML replication: Oracle GoldenGate automaticallys ignore DML for support_mode = INTERNAL tables. Zero Downtime Migration does not set GoldenGate Extract parameter TABLEEXCLUDE for tables with support_mode = INTERNAL.

Global Temporary Tables are always excluded.

DDL replication: If you set parameter GOLDENGATESETTINGS_REPLICATEDDL = TRUE, then Zero Downtime Migration sets Oracle GodenGate Extract parameter DDLOPTIONS CAPTUREGLOBALTEMPTABLE.

Migrating Tables with support_mode = ID KEY

Under normal operation Zero Downtime Migration reports an error listing all user tables with Oracle GoldenGate support_mode = ID KEY.

If you set parameter GOLDENGATESETTINGS_USEFLASHBACKQUERY = TRUE, Zero Downtime Migration sets the following Oracle GoldenGate Extract parameters that allow ID KEY support mode objects to be replicated.

  • STATOPTIONS REPORTFETCH

  • FETCHOPTIONS USESNAPSHOT, NOUSELATESTVERSION, MISSINGROW REPORT

Ensure that the source database has sufficient UNDO size to allow Oracle GoldenGate to use Flashback Query. For best fetch results, configure the source database as documented at Setting Flashback Query in Using Oracle GoldenGate with Oracle Database.


Page 6

Ensure that the subnet Amazon RDS security policy allows connections from Zero Downtime Migration to the DB instance on the specified secure port. See the AWS documentation for details:

Scenarios for accessing a DB instance in a VPC

Scenarios for accessing a DB instance not in a VPC

Setting Endpoint Information

  1. Find the Amazon RDS Oracle Instance endpoint (DNS name) and port number in the RDS console DB Instance Connectivity & security tab.

    See Finding the endpoint of your Oracle DB instance for detailed help.

  2. Specify the endpoint and port number information in following Zero Downtime Migration logical response file parameters:

    SOURCEDATABASE_ADMINUSERNAME

    SOURCEDATABASE_CONNECTIONDETAILS_HOST

    SOURCEDATABASE_CONNECTIONDETAILS_SERVICENAME

    SOURCEDATABASE_CONNECTIONDETAILS_PORT

  3. If connecting to Amazon RDS from the Zero Downtime Migration service host requires a proxy, then specify these logical response file parameters:

    SOURCEDATABASE_CONNECTIONDETAILS_PROXYDETAILS_HOSTNAME

    SOURCEDATABASE_CONNECTIONDETAILS_PROXYDETAILS_PORT

Allowing Zero Downtime Migration to connect to Amazon RDS Oracle DB instance using SSL/TLS

  1. Enable Secure Socket Layer (SSL) or Transport Layer Security (TLS) in the Amazon RDS Oracle Instance to secure the connection from Zero Downtime Migration to Amazon RDS Oracle Instance. See Encrypting client connections with SSL for details.

  2. Create an orapki wallet as detailed in Updating applications to use new SSL/TLS certificates.

  3. Set the following parameters in the Zero Downtime Migration logical response file:

    SOURCEDATABASE_CONNECTIONDETAILS_TLSDETAILS_DISTINGUISHEDNAME

    SOURCEDATABASE_CONNECTIONDETAILS_TLSDETAILS_CREDENTIALSLOCATION


Page 7

You can get data from one or more user actions and use that data to run another user action. For example, you can perform an action on the source database and use that data to perform an action on the target database.

When adding a user action, you can use the -outputfrom option to provide the list of user actions whose output will be supplied to the user action being added.

In the following example there are two user actions already registered in Zero Downtime Migration, USERAC1 and USERAC2, both of which generate some output. This output can be used by a third user action, USERAC3, by listing them with the -outputfrom option, as shown here.

$ZDM_HOME/bin/zdmcli add useraction -useraction USERAC3 -actionscript useractionscript.sh -outputfrom USERAC1,USERAC2

Accessing the Data

The output file is copied to the same location where the useraction file runs from, so the content of the output file can be accessed from the same location.

  • On an Autonomous Database system:

    To access the output file in an Autonomous Database system user action SQL script, use

    @:ACTION_OUTPUT_DIR/useraction_name.out

    Note that ACTION_OUTPUT_DIR indicates the directory where outputs will be stored, and @ will replace this variable with the actual directory path.

    For example, to use output from the get_ddl1 user action, specify

    @:ACTION_OUTPUT_DIR/get_ddl1.out;.

  • On a Co-Managed database system:

    To access the output file in a user action script run on a co-managed database system, use

    OUTPUTFILE=$CURR_DIR/useraction_name.out;.

    Where CURR_DIR is the current directory where the target user action file and the output from the other user actions are placed.

    For example, to use output from the get_ddl1 user action, specify

    OUTPUTFILE=$CURR_DIR/get_ddl1.out;.

    The user action script must also contain the parameter RHP_UA_CHAIN_LIST which gives the list of chained user action names.

Example User Actions in an Autonomous Database Migration

The following example shows how to get DDL output from the source database, and runs it on the target database.

User action get_ddl1 runs on the source database and generates DDL output.

$ZDM_HOME/bin/zdmcli add useraction -useraction get_ddl1 -phase ZDM_VALIDATE_SRC -pre -optype MIGRATE_DATABASE -runscope ONENODE -onerror ABORT -actionscript /home/useraction1.sh

User action table_fromddl runs on the target database, and uses the output from user action get_ddl1.

$ZDM_HOME/bin/zdmcli add useraction -useraction table_fromddl -phase ZDM_VALIDATE_TGT -pre -optype MIGRATE_DATABASE -runscope ONENODE -onerror ABORT -actionscript /home/useraction2.sh -outputfrom get_ddl1

Adding both user actions to an imagetype:

$ZDM_HOME/bin/zdmcli add imagetype -imagetype OUTPUTIMG1 -basetype CUSTOM_PLUGIN -useractions get_ddl1,table_fromddl

Content of useraction1.sh:

#!/bin/sh for var in $@ do if [[ $var == *"ZDM_SRCDBHOME="* ]] then IFS='=' read -ra PATHARR <<< "$var" SRCDBHOME=${PATHARR[1]} fi if [[ $var == *"LOG_PATH"* ]] then IFS='=' read -ra PATHARR <<< "$var" LOGPATH=${PATHARR[1]} fi done echo $SRCDBHOME; ORACLE_HOME=$SRCDBHOME; export ORACLE_HOME; ORACLE_SID=zdm1121; export ORACLE_SID; export TMPLOG=/tmp/tmptmp.log; true>$TMPLOG; export PATH=$ORACLE_HOME/bin:$PATH #echo "home is $ORACLE_HOME"; $ORACLE_HOME/bin/sqlplus -s / as sysdba 2>> $TMPLOG << EOF > /tmp/testlog whenever sqlerror exit 1 SET PAGESIZE 60 SET LINESIZE 1300 SET VERIFY OFF TRIMSPOOL ON HEADING OFF TERMOUT OFF FEEDBACK OFF spool ${TMPLOG} append; select dbms_metadata.get_ddl('TABLE', 'TEST1') from DUAL; spool off EOF SQLRETURN=$? if [ "$SQLRETURN" -ne "0" ]; then echo "Failed to run $SQLRETURN"; fi sed -i 's/PCTFREE 10 PCTU//g' $TMPLOG; echo "$(cat $TMPLOG)";

Content of useraction2.sh:

select name from v$database; @:ACTION_OUTPUT_DIR/ZDM_VALIDATE_SRC_PRE_get_ddl1.out; select name from v$database;

Example User Actions in a Co-Managed Database Migration

For this example, the add useraction and add imagetype commands are same as above in the Autonomous Database use case, but the script contents are different.

Content of useraction1.sh

#!/bin/sh for var in $@ do if [[ $var == *"ZDM_SRCDBHOME="* ]] then IFS='=' read -ra PATHARR <<< "$var" SRCDBHOME=${PATHARR[1]} fi done ORACLE_HOME=$SRCDBHOME; export ORACLE_HOME; ORACLE_SID=zdmsrc1; export ORACLE_SID; export TMPLOG=/tmp/tmptmp.log; true>$TMPLOG; export PATH=$ORACLE_HOME/bin:$PATH #echo "home is $ORACLE_HOME"; $ORACLE_HOME/bin/sqlplus -s / as sysdba 2>> $TMPLOG << EOF > /tmp/testlog whenever sqlerror exit 1 SET PAGESIZE 60 SET LINESIZE 1300 SET VERIFY OFF TRIMSPOOL ON HEADING OFF TERMOUT OFF FEEDBACK OFF spool ${TMPLOG} append; select dbms_metadata.get_ddl('TABLE', 'TEST1') from DUAL; spool off EOF SQLRETURN=$? if [ "$SQLRETURN" -ne "0" ]; then echo "Failed to run $SQLRETURN"; fi echo "$(cat $TMPLOG)";

Content of useraction2.sh:

#!/bin/sh for var in $@ do if [[ $var == *"ZDM_TARGETDBHOME="* ]] then IFS='=' read -ra PATHARR <<< "$var" TARGETDBHOME=${PATHARR[1]} fi done CURR_DIR=$(dirname "$(readlink -f "$0")") export OUTPUTFILE=$CURR_DIR/get_ddl1.out; # export ORACLE_HOME=/u01/app/oracle/product/19.0.0.0/dbhome_1; ORACLE_HOME=$TARGETDBHOME; export ORACLE_HOME; ORACLE_SID=zdmnov19; export ORACLE_SID; export TMPLOG=/tmp/tmptmp.log; sed -i 's/PCTFREE 10 PCTUS//g' $OUTPUTFILE; export OUTPUT=$(cat $OUTPUTFILE); echo $OUTPUT; echo "">$TMPLOG; $ORACLE_HOME/bin/sqlplus -s / as sysdba 2>> $TMPLOG << EOF > /tmp/testlog whenever sqlerror exit 1 SET PAGESIZE 60 SET LINESIZE 1300 SET VERIFY OFF TRIMSPOOL ON HEADING OFF TERMOUT OFF FEEDBACK OFF spool ${TMPLOG} append; $OUTPUT; spool off EOF echo "$(cat $TMPLOG)"; #SELECT 'NAME: '|| NAME FROM V\$DATABASE;


Page 8

Before submitting the database migration job for the production database, perform a test migration to determine how the process might fare with your configuration and settings.

It is highly recommended that for each migration job, you first run migrate database in evaluation mode. Evaluation mode allows you to correct any potential problems in the setup and configuration before performing the actual migration on a production database.

In evaluation mode, the migration process runs without effecting the changes. It is safe to run a migration job in evaluation mode as many times as needed before running the actual migration job.

The migrate database output indicates the migration job ID, which you can use to query the status of the job.

To run an evaluation of the migration job, run the ZDMCLI command migrate database with the -eval option, as shown in the following example.

Log in to the Zero Downtime Migration service host and switch to the zdmuser installed user.

su - zdmuser

If connectivity to the source database server is done through root credentials then the command would be the following:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb source_db_unique_name_value -sourcenode source_database_server_name -srcroot -targetnode target_database_server_name -backupuser Object_store_login_user_name -rsp response_file_location -tgtauth zdmauth -tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location -tgtarg3 sudo_location:/usr/bin/sudo -eval

For the prompts, specify the source database SYS password and the source database server root user password. If the backup destination is Object Store (Bucket), then specify user swift authentication token. If the backup destination is Storage Classic (Container) then specify your tenancy login password.

For example,

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb zdmsdb -sourcenode ocicdb1 -srcroot -targetnode ocidb1 -backupuser -rsp /u01/app/zdmhome/rhp/zdm/template/zdm_template_zdmsdb.rsp -tgtauth zdmauth -tgtarg1 user:opc -tgtarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -tgtarg3 sudo_location:/usr/bin/sudo -eval Enter source database zdmsdb SYS password: Enter source user "root" password: Enter user "" password:

If connectivity to the source database server is through SSH key, then the command would be:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb source_db_unique_name_value -sourcenode source_database_server_name -srcauth zdmauth -srcarg1 user:source_database_server_login_user_name -srcarg2 identity_file:ZDM_installed_user_private_key_file_location -srcarg3 sudo_location:/usr/bin/sudo -targetnode target_database_server_name -backupuser Object_store_login_user_name -rsp response_file_location -tgtauth zdmauth -tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location -tgtarg3 sudo_location:/usr/bin/sudo -eval

For the prompts, specify the source database SYS password. If the backup destination is Object Store (Bucket), then specify user swift authentication token. If the backup destination is Storage Classic (Container), then specify your tenancy login password.

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb zdmsdb -sourcenode ocicdb1 -srcauth zdmauth -srcarg1 user:opc -srcarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -srcarg3 sudo_location:/usr/bin/sudo -targetnode ocidb1 -backupuser -rsp /u01/app/zdmhome/rhp/zdm/template/zdm_template_zdmsdb.rsp -tgtauth zdmauth -tgtarg1 user:opc -tgtarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -tgtarg3 sudo_location:/usr/bin/sudo -eval Enter source database zdmsdb SYS password: Enter user "" password:

Note that if a source single instance database is deployed without a Grid Infrastructure home, then in the above command use -sourcesid in place of -sourcedb.

Also, if a source database is configured for a PASSWORD based wallet, then add the -tdekeystorepasswd option to the command above, and for the prompt, specify the source database TDE keystore password value.

Note that the –backupuser argument takes the Object Storage access user or Zero Data Loss Recovery Appliance VPC user, and is skipped if NFS is the backup medium. For NFS, the source database user should have ‘rwx’ access to the NFS path provided.

The migration command checks for patch compatibility between the source and target home patch level, and expects the target home patch level to be equal to or higher than the source. If the target home patch level is not as expected, then the migration job is stopped and missing patches are reported. You can either patch the target home with the necessary patches or you can force continue the migration by appending the –ignore PATCH_CHECK or -ignore ALL option to the migration command.

When you run migrate database with -eval, Zero Downtime Migration only runs a subset of the migration job phases. For example, a logical migration job run with -eval would only run the following phases:

ZDM_VALIDATE_SRC

ZDM_VALIDATE_TGT

ZDM_SETUP_SRC

ZDM_PRE_MIGRATION_ADVISOR

ZDM_VALIDATE_DATAPUMP_SETTINGS_SRC

ZDM_VALIDATE_DATAPUMP_SETTINGS_TGT

ZDM_PREPARE_DATAPUMP_SRC

ZDM_DATAPUMP_ESTIMATE_SRC

ZDM_CLEANUP_SRC

The migrate database output indicates the job ID for the migration job, which you can use to query the status of the job.

If you want to run the command without providing passwords at the command line, see Providing Passwords Non-Interactively Using a Wallet.


Page 9

You can discover and set the port number that Zero Downtime Services uses for MySQL.

MySQL Default Port Number

Zero Downtime Migration uses MySQL internally, configuring it by default on port 3306. If a port number is not specified and the default is not available, Zero Downtime Migration increases the port value by one and retries up to five times.

Finding the Current Port Number

Run zdmservice status to see the current MySQL port number in the connection string, as shown here.

zdmuser> $ZDM_HOME/bin/zdmservice status Conn String: jdbc:mysql://localhost:8897/

Changing the Port Number

You can change this default to another value using the zdmservice modify mysqlPort=port option.

zdmuser> $ZDM_HOME/bin/zdmservice modify mysqlPort=port


Page 10

If your migration job fails, the following logs can help you discover the issue.

Migration Job Output Logs

If your migration job encounters an error, refer to the migration job output logs, Zero Downtime Migration service logs, and server-specific operational phase logs present at the respective source or target database servers.

If the migration job encounters an exception (that is, fails) then the logs can provide some indication of the nature of the fault. The logs for the migration procedures executed in the source and target environments are stored on the servers in the respective source and target environments. The Zero Downtime Migration command output location is provided to you when the migration job is run with the ZDMCLI command migrate database. You can also find the log file location (Result file path) in the output of the ZDMCLI command query job -jobid job-id.

Zero Downtime Migration Service Host Log

Determine which operational phase the migration job was in at the time of failure, and whether the phase belongs to the source (phase name contains SRC) or target (phase name contains TGT) . Check the Zero Downtime Migration service host log at $ZDM_BASE/crsdata/zdm_service_host/rhp/zdmserver.log.0, and access the respective source or target server to check the log associated with the operational phase in $ORACLE_BASE/zdm/zdm_db_unique_name_job-id/zdm/log.

If the Zero Downtime Migration service does not start, then check the Zero Downtime Migration service logs for process start-up errors to determine the cause of the error reported. The Zero Downtime Migration service log can be found at $ZDM_BASE/crsdata/zdm_service_host/rhp/zdmserver.log.0.

Data Pump Log

For logical migration jobs on co-managed target databases, refer to the Data Pump log in the specified DATA_PUMP_DIR. For Autonomous Database targets, the Data Pump logs are uploaded to a data bucket specified with DATAPUMPSETTINGS_DATABUCKET_* in the response file. If the data bucket is not specified, then you will need to upload the dump from Autonomous Database to Object Storage to access it. See How To View Import Log Generated For ADW/ATP (Doc ID 2448060.1)

If a migration job fails, you can fix the cause of the failure and then re-run the job while monitoring the logs for progress.


Page 11

Zero Downtime Migration lets you configure connectivity to the source and target database servers through a bastion host for both physical and logical migration work flows.

Note that a bastion host cannot be used to connect to an Autonomous Database, except for JDBC connections.

Use the following sections to configure the appropriate parameters for physical and logical migrations that must connect to the source or target database server through a bastion host.

SSH Connection to Database Servers

Connecting database servers through a bastion host requires the following information:

  • Bastion Host IP Address and Source Database Server IP Address: To connect to the database server through a bastion host, the bastion host IP address and the source node IP address are required.

  • Bastion Port Number: The port number defaults to 22 if not specified.

  • Bastion User: The bastion host user is only required if the user specified for the argument zdmauth plug-in is different from the user of the bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the property is not specified.

  • Bastion Identity File: If the SRC/TGT_BASTION_IDENTITY_FILE parameter is not specified, the value defaults to the value specified for the identity_file argument of the zdmauth plug-in argument.

Physical Migration Response File Parameters

Configure the following response file parameters for a physical migration.

Source Database Server

SRC_BASTION_HOST_IP=

SRC_BASTION_PORT=

SRC_BASTION_USER=

SRC_BASTION_IDENTITY_FILE=

SRC_HOST_IP=

Target Database Server

TGT_BASTION_HOST_IP=

TGT_BASTION_PORT=

TGT_BASTION_USER=

TGT_BASTION_IDENTITY_FILE=

TGT_HOST_IP=

Logical Migration Response File Parameters

Configure the following response file parameters for a logical migration.

Source Database Server

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IP=

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_PORT=

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IDENTITYFILE=

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_USERNAME=

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_REMOTEHOSTIP=

Target Database Server (including Autonomous Database)

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IP=

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_PORT=22

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IDENTITYFILE=

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_USERNAME=

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_REMOTEHOSTIP=


Page 12

Zero Downtime Migration does not always require encryption at the source (although, all Cloud databases are encrypted by default). The following tables list specific cases when encryption is not required.

Table B-1 On-Premises Unencrypted Primary and Cloud Encrypted Standby

Operation On-Premises Primary 11g R2 Cloud Standby 11g R2 On-Premises Primary 12c R1 Cloud Standby 12c R1 On-Premises Primary 12c R2 Cloud Standby 12c R2 and later Notes
Data Guard initial setup for on-premises primary and cloud standby Unencrypted Encrypted Unencrypted Encrypted Unencrypted Encrypted In these cases the standby database is manually encrypted after instantiation
New tablespace creation on-premises primary Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted Requires manual TDE conversion for standby database
Redo generated in on-premises primary Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted
Archived logs Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted Unencrypted
New and changed blocks Unencrypted Encrypted Unencrypted Encrypted Unencrypted Encrypted Redo shipped from the on-premises primary to the cloud is not encrypted
Recovery in the cloud standby N/A Encrypted N/A Encrypted N/A Encrypted Redo shipped from the on-premises primary to the cloud is not encrypted

Table B-2 Cloud Encrypted Primary and On-Premises Unencrypted Standby

Operation Cloud Primary 11g R2 On-Premises Standby 11g R2 Cloud Primary 12c R1 On-Premises Standby 12c R1 Cloud Primary 12c R2 On-Premises Standby 12c R2 and later Notes
New tablespace creation in cloud primary Encrypted Encrypted Encrypted Encrypted Encrypted Encrypted ASO required for on-premises to decrypt
Redo generated in cloud primary Encrypted Encrypted Encrypted Encrypted Encrypted Encrypted ASO required for on-premises to decrypt
Archived logs Encrypted Encrypted Encrypted Encrypted Encrypted Encrypted ASO required for on-premises to decrypt
New and changed blocks for existing unencrypted tablespace on standby Encrypted Encrypted* Encrypted Encrypted* Encrypted Unencrypted ASO is required on-premises to decrypt and encrypt

* For 11g R2 and 12c R1 redo apply will encrypt only if redo is encrypted

Recovery in the on-premises standby N/A Encrypted N/A Encrypted N/A Unencrypted data depends on whether the datafile is encrypted ASO required for on-premises database


Page 13

You can avoid entering passwords in the command line and run the ZDMCLI migrate database command without user interaction, such as when you do automation using Rundeck.

Currently, whenever you submit the $ZDM_HOME/bin/zdmcli migrate database command, it prompts for the source database SYS password, Object Store user swift authentication token, and the source database Transparent Data Encryption (TDE) keystore password (if the wallet was configured as a PASSWORD-based TDE wallet).

Wallet Creation Examples

The following examples show how to create auto-login wallets for the source database SYS user, the Object Store user, the source database TDE keystore, and the target CDB database TDE keystore password.

Run the following commands on the Zero Downtime Migration service host as Zero Downtime Migration software owner (for example, zdmuser).

To create an auto-login wallet for the source database SYS user:

  1. Create a directory where you want to create and store the wallet.

    zdmuser> mkdir sys_wallet_path

    For example:

    /u01/app/zdmhome> mkdir sysWallet
  2. Create a wallet.

    zdmuser> $ZDM_HOME/bin/orapki wallet create -wallet sys_wallet_path -auto_login_only

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/orapki wallet create -wallet sysWallet -auto_login_only Oracle PKI Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Operation is successfully completed.
  3. Add a SYS user login credentials to wallet.

    zdmuser> $ZDM_HOME/bin/mkstore -wrl sys_wallet_path -createCredential store sysuser

    At the prompt, enter the source database SYS password.

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/mkstore -wrl ./sysWallet -createCredential store sysuser Oracle Secret Store Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Your secret/Password is missing in the command line Enter your secret/Password: Re-enter your secret/Password:
  4. Verify that the wallet files were created.

    zdmuser> ls -l sys_wallet_path

    For example

    /u01/app/zdmhome> ls -l sysWallet/ total 4 -rw-------. 1 opc opc 581 Jun 2 08:00 cwallet.sso -rw-------. 1 opc opc 0 Jun 2 08:00 cwallet.sso.lck

To create an auto-login wallet for the Object Store user:

  1. Create a directory where you want to create and store the wallet.

    zdmuser> mkdir oss_wallet_path

    For example

    /u01/app/zdmhome> mkdir ossWallet
  2. Create a wallet

    zdmuser> $ZDM_HOME/bin/orapki wallet create -wallet oss_wallet_path -auto_login_only

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/orapki wallet create -wallet ./ossWallet -auto_login_only Oracle PKI Tool Release 19.0.0.0.0 -Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Operation is successfully completed.
  3. Add the Object Store user login credentials to the wallet.

    zdmuser> $ZDM_HOME/bin/mkstore -wrl oss_wallet_path -createCredential store ossuser

    For the prompt,

    • If the backup destination is Object Store (Bucket), then enter the user swift authentication token.

    • If the backup destination is Storage Classic (Container), then enter your tenancy login password.

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/mkstore -wrl ./ossWallet -createCredential store ossuser Oracle Secret Store Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Your secret/Password is missing in the command line Enter your secret/Password: Re-enter your secret/Password:
  4. Verify that the wallet files were created.

    zdmuser> ls -l oss_wallet_path

    For example

    /u01/app/zdmhome> ls -l ./ossWallet total 4 -rw-------. 1 opc opc 597 Jun 2 08:02 cwallet.sso -rw-------. 1 opc opc 0 Jun 2 08:01 cwallet.sso.lck

To create an auto-login wallet for the source database TDE keystore:

  1. Create a directory where you want to create and store the wallet.

    zdmuser> mkdir tde_wallet_path

    For example

    /u01/app/zdmhome> mkdir tdeWallet
  2. Create a wallet.

    zdmuser> $ZDM_HOME/bin/orapki wallet create -wallet tde_wallet_path -auto_login_only

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/orapki wallet create -wallet ./tdeWallet -auto_login_only Oracle PKI Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Operation is successfully completed.
  3. Add the source database TDE keystore credentials to the wallet.

    zdmuser> $ZDM_HOME/bin/mkstore -wrl tde_wallet_path -createCredential store tdeuser

    At the prompt, enter the TDE keystore password.

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/mkstore -wrl ./tdeWallet -createCredential store tdeuser Oracle Secret Store Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Your secret/Password is missing in the command line Enter your secret/Password: Re-enter your secret/Password:
  4. Verify that the wallet files were created.

    zdmuser> ls -l tde_wallet_path

    For example

    /u01/app/zdmhome> ls -l tdeWallet total 4 -rw-------. 1 opc opc 581 Jun 2 08:06 cwallet.sso -rw-------. 1 opc opc 0 Jun 2 08:04 cwallet.sso.lck

To create an auto-login wallet for the target CDB database TDE keystore password:

  1. Create a directory where you want to create and store the wallet.

    zdmuser> mkdir cdb_tde_wallet_path

    For example

    /u01/app/zdmhome> mkdir cdbtdeWallet
  2. Create a wallet.

    zdmuser> $ZDM_HOME/bin/orapki wallet create -wallet cdb_tde_wallet_path -auto_login_only

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/orapki wallet create -wallet ./cdbtdeWallet -auto_login_only Oracle PKI Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Operation is successfully completed.
  3. Add the source database TDE keystore credentials to the wallet.

    zdmuser> $ZDM_HOME/bin/mkstore -wrl cdb_tde_wallet_path -createCredential store cdbtdeuser

    At the prompt, enter the TDE keystore password.

    For example

    /u01/app/zdmhome> $ZDM_HOME/bin/mkstore -wrl ./cdbtdeWallet -createCredential store cdbtdeuser Oracle Secret Store Tool Release 19.0.0.0.0 - Production Version 19.4.0.0.0 Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved. Your secret/Password is missing in the command line Enter your secret/Password: Re-enter your secret/Password:

Accessing the Wallets in a Logical Migration Job

In a logical migration you configure the wallet parameters using the RSP WALLET_* parameters appropriate for your migration use case. See the following links for details about the individual parameters.

Accessing the Wallets in a Physical Migration Job

In a physical migration you configure the wallet parameters as options in the ZDMCLI database migration command. See migrate database for information about the database migration options.

  • -sourcesyswallet sys_wallet_path: Source database SYS password wallet path
  • -osswallet oss_wallet_path: Object Storage Service (OSS) backup user wallet path
  • -dvwallet dv_wallet_path: Oracle Database Vault owner wallet path
  • -tdekeystorewallet tde_wallet_path: Transparent Data Encryption (TDE) keystore password wallet path
  • -tgttdekeystorewallet tde_wallet_path: Target container database TDE keystore password wallet path
  • -backupwallet backup_wallet_path: RMAN backup password wallet path

Note that if you are converting a non-multitenant source database to a multitenant architecture on the target, that is a pluggable database (PDB), then you can also create an auto-login wallet for the target container database (CDB) TDE keystore password.

Setting Command Options to Access the Wallets

To specify wallet information in the ZDMCLI MIGRATE DATABASE command, set the -sourcesyswallet, -osswallet, -tdekeystorewallet, and -tgttdekeystorewallet options as shown here.

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb source_db_unique_name_value -sourcenode source_database_server_name -srcauth zdmauth -srcarg1 user:source_database_server_login_user_name -srcarg2 identity_file:zdm_installed_user_private_key_file_location -srcarg3 sudo_location:/usr/bin/sudo -targetnode target_database_server_name -backupuser object_store_login_user_name -rsp response_file_location -tgtauth zdmauth -tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:zdm_installed_user_private_key_file_location -tgtarg3 sudo_location:/usr/bin/sudo -sourcesyswallet sys_wallet_path -osswallet oss_wallet_path -tdekeystorewallet tde_wallet_path -tgttdekeystorewallet cdb_tde_wallet_path -eval
  • -sourcesyswallet sys_wallet_path specifies the full path for the auto-login wallet file on the Zero Downtime Migration host containing the SYS password of the source database
  • -osswallet oss_wallet_path specifies the full path for the auto-login wallet file on the Zero Downtime Migration host containing credentials for the Object Storage Service backup user
  • -tdekeystorewallet tde_wallet_path specifies the full path for the auto-login wallet file on the Zero Downtime Migration host containing the TDE keystore password
  • -tgttdekeystorewallet cdb_tde_wallet_path specifies the full path for the auto-login wallet file on the Zero Downtime Migration host containing the target CDB TDE keystore password

Evaluation Mode Example

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb zdmsdb -sourcenode ocicdb1 -srcauth zdmauth -srcarg1 user:opc -srcarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -srcarg3 sudo_location:/usr/bin/sudo -targetnode ocidb1 -backupuser -rsp /u01/app/zdmhome/rhp/zdm/template/zdm_template_zdmsdb.rsp -tgtauth zdmauth -tgtarg1 user:opc -tgtarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -tgtarg3 sudo_location:/usr/bin/sudo -sourcesyswallet /u01/app/zdmhome/sysWallet -osswallet /u01/app/zdmhome/ossWallet -eval Operation "zdmcli migrate database" scheduled with the job ID "1".

Migration Mode Example

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -sourcedb zdmsdb -sourcenode ocicdb1 -srcauth zdmauth -srcarg1 user:opc -srcarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -srcarg3 sudo_location:/usr/bin/sudo -targetnode ocidb1 -backupuser -rsp /u01/app/zdmhome/rhp/zdm/template/zdm_template_zdmsdb.rsp -tgtauth zdmauth -tgtarg1 user:opc -tgtarg2 identity_file:/home/zdmuser/.ssh/zdm_service_host.ppk -tgtarg3 sudo_location:/usr/bin/sudo -sourcesyswallet /u01/app/zdmhome/sysWallet -osswallet /u01/app/zdmhome/ossWallet Operation "zdmcli migrate database" scheduled with the job ID "2".


Page 14

ZDM_VALIDATE_TGT

Both

Verifies that the target database exists, discovers the database type, and validates access credentials, security, and connectivity.

For an Autonomous Database target, sets up the access to the target database from the Zero Downtime Migration node by downloading the target database access wallet with OCI REST services and discovers the target OCPU.

Online only: verifies ggadmin user privileges.


Page 15

The following topics describe the Zero Downtime Migration response file parameters used in physical migrations.

BACKUP_PATH specifies a valid path accessible at the source and target for migration backup type.

Property Description

Syntax

BACKUP_PATH = {STORAGEPATH | EXTBACKUP}

Default value

There is no default value.

Range of values

STORAGEPATH - NFS backup location

EXTBACKUP - external backup location

Leave this parameter value blank for other migration backup types

DATA_TRANSFER_MEDIUM specifies the media used for the source database backup, or you can specify a direct data transfer method.

Property Description

Syntax

DATA_TRANSFER_MEDIUM = {OSS | EXTBACKUP | ZDLRA | NFS | DIRECT}

Default value

OSS

Range of values

  • OSS - When MIGRATION_METHOD=ONLINE_PHYSICAL, Oracle Data Guard using OSS for standby initialization, supported for Oracle Cloud Infrastructure(OCI) virtual machine or bare metal, Exadata Cloud Service (EXACS) and Exadata Cloud at Customer (EXACC)

    When MIGRATION_METHOD=OFFLINE_PHYSICAL, specifying OSS will perform the migration using backup and restore through OSS, supported for Oracle Cloud Infrastructure(OCI) virtual machine or bare metal, Exadata Cloud Service (EXACS) and Exadata Cloud at Customer (EXACC) and no SQL*Net connectivity needed between source and target

  • EXTBACKUP - Oracle Data Guard with existing backup in external location, supported for Exadata Cloud at Customer (EXACC)
  • ZDLRA - Oracle Data Guard using ZDLRA for standby initialization, supported for Exadata Cloud at Customer (EXACC)
  • NFS - When MIGRATION_METHOD=ONLINE_PHYSICAL, Oracle Data Guard using backup location such as NFS, supported for Exadata Cloud at Customer (EXACC)

    When MIGRATION_METHOD=OFFLINE_PHYSICAL, specifying NFS performs the migration using backup and restore through NFS, supported for Exadata Cloud at Customer (EXACC) and no SQL*Net connectivity needed between source and target

  • DIRECT - RMAN active database duplication or restore from service to transfer data directly from the source to the target, This transfer method also uses the ZDM_RMAN_DIRECT_METHOD and ZDM_SRC_DB_RESTORE_SERVICE_NAME parameters.

    See Direct Data Transfer Support and Setting Physical Migration Parameters for more information about using direct data transfer in a physical migration

DATAPATCH_WITH_ONE_INSTANCE_RUNNING specifies whether or not to stop all instances except one running on the target database server when the datapatch utility is run. When datapatch completes all of the stopped instances are started.

Property Description

Syntax

DATAPATCH_WITH_ONE_INSTANCE_RUNNING ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Stops all instances except one running on the target database server when running the datapatch utility.

FALSE - Does not stop all instances except one running on the target database server when running the datapatch utility.

HOST specifies the cloud storage REST endpoint URL to access Oracle Cloud Object Storage.

Property Description

Syntax

HOST = rest_endpoint_url

Default value

There is no default value.

Range of values

For Oracle Cloud Infrastructure storage the typical value format is

https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/ObjectStorageNamespace

For Oracle Cloud Infrastructure Classic storage the typical value format is

https://acme.storage.oraclecloud.com/v1/Storage-tenancy name

Usage Notes

To access Oracle Cloud Object Storage, you must set both the HOST and OPC_CONTAINER parameters.

MAX_DATAPATCH_DURATION_MINS specifies a timeout value, in minutes, after which if the datapatch utility has failed to complete then the operation is stopped.

Property Description

Syntax

MAX_DATAPATCH_DURATION_MINS = minutes

Default value

There is no default value. Zero Downtime Migration waits until datapatch completes by default.

MIGRATION_METHOD specifies whether the migration uses Oracle Data Guard (online) or backup and restore (offline).

Property Description

Syntax

MIGRATION_METHOD = {ONLINE_PHYSICAL | OFFLINE_PHYSICAL}

Default value

This is no default value

Range of values

ONLINE_PHYSICAL uses Data Guard switchover migration method

OFFLINE_PHYSICAL uses backup and restore database migration method

NONCDBTOPDB_CONVERSION indicates whether to convert a source database from non-CDB to PDB or skip the conversion.

Property Description

Syntax

NONCDBTOPDB_CONVERSION = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE performs the conversion

FALSE does not perform the conversion

NONCDBTOPDB_SWITCHOVER, for a physical migration using Data Guard switchover, indicates whether the switchover operations will be executed during a migration job with non-CDB to PDB conversion enabled.

Property Description

Syntax

NONCDBTOPDB_SWITCHOVER = {TRUE | FALSE}

Default value

TRUE

Range of values

TRUE performs the switchover

FALSE does not perform the switchover

OPC_CONTAINER specifies the Object Storage bucket (called the container on Oracle Cloud Infrastructure Classic), and is set to access Oracle Cloud Object Storage.

Property Description

Syntax

OPC_CONTAINER = bucket

Default value

There is no default value.

Usage Notes

To access Oracle Cloud Object Storage, you must set both the HOST and OPC_CONTAINER parameters.

The bucket is also referred to as a container for Oracle Cloud Infrastructure Classic storage.

PLATFORM_TYPE specifies the target database platform.

Property Description

Syntax

PLATFORM_TYPE = {VMDB | EXACS | EXACC | NON_CLOUD}

Default value

VMDB

Range of values

VMDB - indicates target platform is Oracle Cloud Infrastructure(OCI) virtual machine or bare metal

EXACS - indicates target platform is Exadata Cloud Service

EXACC - indicates target platform is Exadata Cloud at Customer

NON_CLOUD - indicates the target is an on-premises environment

SHUTDOWN_SRC specifies whether or not to shut down the source database after migration completes.

Property Description

Syntax

SHUTDOWN_SRC ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Shut down the source database after migration completes.

FALSE - Dos not shut down the source database after migration completes.

SKIP_FALLBACK specifies whether or not to ship redo logs from the primary (target) database to the standby (source) database, either voluntarily or because there is no connectivity between the target and source database servers.

Property Description

Syntax

SKIP_FALLBACK = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - do not ship redo logs from the primary (target) database to the standby (source) database.

FALSE - ship redo logs from the primary (target) database to the standby (source) database.

SKIP_SRC_SERVICE_RETENTION specifies whether or not to retain the source database services and run them on the target database. This parameter is only effective for the BACKUP_RESTORE_OSS and BACKUP_RESTORE_NFS migration methods.

Property Description

Syntax

SKIP_SRC_SERVICE_RETENTION ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Do not retain the source database services.

FALSE - Retain the source database services.

SRC_BASTION_HOST_IP specifies the bastion host IP address, if you want to connect to the source database server using a bastion host.

Property Description

Syntax

SRC_BASTION_HOST_IP = IP_address

Default value

There is no default value.

Usage Notes

If you want to connect to the source database server using a bastion host, values for the bastion host IP address parameter, SRC_BASTION_HOST_IP, and the source database host IP address parameter, SRC_HOST_IP, are required in the Zero Downtime Migration response file.

If you do not want to use the default value, set the following parameters for bastion host connection.

SRC_BASTION_PORT - The port number defaults to 22 if not specified.

SRC_BASTION_USER - The bastion host source user is only required if the user specified for the source zdmauth plug-in is different from the user of the source bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

SRC_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

SRC_BASTION_IDENTITY_FILE specifies the bastion user, if you want to connect to the source database server using a bastion host.

Property Description

Syntax

SRC_BASTION_IDENTITY_FILE = identity_file

Default value

If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

Usage Notes

If you want to connect to the source database server using a bastion host, values for the bastion host IP address parameter, SRC_BASTION_HOST_IP, and the source database server IP address parameter, SRC_HOST_IP, are required in the Zero Downtime Migration response file.

If you do not want to use the default value, set the following parameters for bastion host connection.

SRC_BASTION_PORT - The port number defaults to 22 if not specified.

SRC_BASTION_USER - The bastion host source user is only required if the user specified for the source zdmauth plug-in is different from the user of the source bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

SRC_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

SRC_BASTION_PORT specifies the bastion host port number, if you want to connect to the source database server using a bastion host.

Property Description

Syntax

SRC_BASTION_PORT = port_number

Default value

22

Usage Notes

If you want to connect to the source database server using a bastion host, values for the bastion host IP address parameter, SRC_BASTION_HOST_IP, and the source database server IP address parameter, SRC_HOST_IP, are required in the Zero Downtime Migration response file.

If you do not want to use the default value, set the following parameters for bastion host connection.

SRC_BASTION_PORT - The port number defaults to 22 if not specified.

SRC_BASTION_USER - The bastion host source user is only required if the user specified for the source zdmauth plug-in is different from the user of the source bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

SRC_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

SRC_BASTION_USER specifies the bastion user, if you want to connect to the source database server using a bastion host.

Property Description

Syntax

SRC_BASTION_USER = bastion_user

Default value

The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

Usage Notes

If you want to connect to the source database server using a bastion host, values for the bastion host IP address parameter, SRC_BASTION_HOST_IP, and the source database server IP address parameter, SRC_HOST_IP, are required in the Zero Downtime Migration response file.

If you do not want to use the default value, set the following parameters for bastion host connection.

SRC_BASTION_PORT - The port number defaults to 22 if not specified.

SRC_BASTION_USER - The bastion host source user is only required if the user specified for the source zdmauth plug-in is different from the user of the source bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

SRC_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

SRC_CONFIG_LOCATION specifies the SSH configuration file location on the Zero Downtime Migration service host (host where Zero Downtime Migration service is running).

Property Description

Syntax

SRC_CONFIG_LOCATION = SSH_config_file_path

Default value

User_home/.ssh/config

Usage Notes

Set SRC_CONFIG_LOCATION to the full path of the SSH configuration file location on the Zero Downtime Migration service host, for example, /home/crsuser/.ssh/config.

SRC_DB_LISTENER_PORT indicates the source database listener port. Set this property when there is Standalone Database (no Grid Infrastructure) configured with non-default SCAN listener port other than 1521.

Property Description

Syntax

SRC_DB_LISTENER_PORT = listener_port_number

Default value

1521

SRC_HOST_IP specifies the bastion user, if you want to connect to the source database server using a bastion host.

Property Description

Syntax

SRC_HOST_IP = IP_address

Default value

There is no default value.

Usage Notes

If you want to connect to the source database server using a bastion host, values for the bastion host IP address parameter, SRC_BASTION_HOST_IP, and the source database server IP address parameter, SRC_HOST_IP, are required in the Zero Downtime Migration response file.

If you do not want to use the default value, set the following parameters for bastion host connection.

SRC_BASTION_PORT - The port number defaults to 22 if not specified.

SRC_BASTION_USER - The bastion host source user is only required if the user specified for the source zdmauth plug-in is different from the user of the source bastion host. The bastion user defaults to the user specified for the source zdmauth plug-in if the parameter is not specified.

SRC_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the source zdmauth plug-in.

SRC_HTTP_PROXY_PORT specifies the HTTPS proxy port number on the source database server if an SSH connection needs to connect using a proxy.

Property Description

Syntax

SRC_HTTP_PROXY_PORT = https_proxy_port_number

Default value

There is no default value.

SRC_HTTP_PROXY_URL specifies the HTTPS proxy URL on the source database server if an SSH connection needs to connect using a proxy.

Property Description

Syntax

SRC_HTTP_PROXY_URL = https_proxy_url

Default value

There is no default value.

SRC_OSS_PROXY_HOST specifies the Object Storage Service proxy host on the source database server if a proxy is needed for connecting to the Object Store.

Property Description

Syntax

SRC_OSS_PROXY_HOST = oss_proxy_host

Default value

There is no default value.

Usage Notes

Set both the SRC_OSS_PROXY_HOST and SRC_OSS_PROXY_PORT parameters if a proxy is needed for connecting to the Object Store.

SRC_OSS_PROXY_PORT specifies the Object Storage Service proxy port number on the source database server if a proxy is needed for connecting to the Object Store.

Property Description

Syntax

SRC_OSS_PROXY_PORT = oss_proxy_port_number

Default value

There is no default value.

Usage Notes

Set both the SRC_OSS_PROXY_HOST and SRC_OSS_PROXY_PORT parameters if a proxy is needed for connecting to the Object Store.

SRC_PDB_NAME indicates the source database PDB name.

Property Description

Syntax

SRC_PDB_NAME = source_database_pdb_name

Default value

No default value

SRC_RMAN_CHANNELS specifies the number of RMAN channels to be allocated at the source database server for performing RMAN backups.

Property Description

Syntax

SRC_RMAN_CHANNELS = number_of_channels

Default value

10

SRC_SSH_RETRY_TIMEOUT specifies a timeout value, in minutes, after which Zero Downtime Migration stops attempting SSH connections after an initial failure to connect.

Property Description

Syntax

SRC_SSH_RETRY_TIMEOUT = number_of_minutes

Default value

There is no default value.

SRC_TIMEZONE specifies the source database server time zone, which is needed for SIDB case when there is no Grid Infrastructure configured.

Property Description

Syntax

SRC_TIMEZONE = source_db_time_zone

Default value

There is no default value.

SRC_ZDLRA_WALLET_LOC specifies the path of the Zero Data Loss Recovery Appliance wallet on the source database server.

Property Description

Syntax

SRC_ZDLRA_WALLET_LOC = source_zdlra_wallet_location

The expected format for the location is /u02/app/oracle/product/12.1.0/dbhome_3/dbs/zdlra

Default value

There is no default value.

Usage Notes

When using Zero Data Loss Recovery Appliance as the migration backup medium, you must set the following parameters.

SRC_ZDLRA_WALLET_LOC

TGT_ZDLRA_WALLET_LOC

ZDLRA_CRED_ALIAS

TGT_BASTION_HOST_IP specifies the bastion host IP address, if you want to connect to the target database server using a bastion host.

Property Description

Syntax

TGT_BASTION_HOST_IP = bastion_ip_address

Default value

There is no default value.

Usage Notes

If you want to connect to the target database server using a bastion host, you are required to configure values for the bastion host IP address parameter, TGT_BASTION_HOST_IP, and the target database server IP address parameter, TGT_HOST_IP, in the Zero Downtime Migration response file.

If you do not want to use the default values for the remaining bastion connection parameters, set the following parameters to configure the bastion host connection.

TGT_BASTION_PORT - The port number defaults to 22 if not specified.

TGT_BASTION_USER - The bastion host target user is only required if the user specified for the target zdmauth plug-in is different from the user of the target bastion host. The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

TGT_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

TGT_BASTION_IDENTITY_FILE specifies the bastion user, if you want to connect to the target database server using a bastion host.

Property Description

Syntax

TGT_BASTION_IDENTITY_FILE = identity_file

Default value

If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

Usage Notes

If you want to connect to the target database server using a bastion host, you are required to configure values for the bastion host IP address parameter, TGT_BASTION_HOST_IP, and the target database server IP address parameter, TGT_HOST_IP, in the Zero Downtime Migration response file.

If you do not want to use the default values for the remaining bastion connection parameters, set the following parameters to configure the bastion host connection.

TGT_BASTION_PORT - The port number defaults to 22 if not specified.

TGT_BASTION_USER - The bastion host target user is only required if the user specified for the target zdmauth plug-in is different from the user of the target bastion host. The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

TGT_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

TGT_BASTION_PORT specifies the bastion host port number, if you want to connect to the target database server using a bastion host.

Property Description

Syntax

TGT_BASTION_PORT = port_number

Default value

22

Usage Notes

If you want to connect to the target database server using a bastion host, you are required to configure values for the bastion host IP address parameter, TGT_BASTION_HOST_IP, and the target database server IP address parameter, TGT_HOST_IP, in the Zero Downtime Migration response file.

If you do not want to use the default values for the remaining bastion connection parameters, set the following parameters to configure the bastion host connection.

TGT_BASTION_PORT - The port number defaults to 22 if not specified.

TGT_BASTION_USER - The bastion host target user is only required if the user specified for the target zdmauth plug-in is different from the user of the target bastion host. The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

TGT_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

TGT_BASTION_USER specifies the bastion user, if you want to connect to the target database server using a bastion host.

Property Description

Syntax

TGT_BASTION_USER = bastion_user

Default value

The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

Usage Notes

If you want to connect to the target database server using a bastion host, you are required to configure values for the bastion host IP address parameter, TGT_BASTION_HOST_IP, and the target database server IP address parameter, TGT_HOST_IP, in the Zero Downtime Migration response file.

If you do not want to use the default values for the remaining bastion connection parameters, set the following parameters to configure the bastion host connection.

TGT_BASTION_PORT - The port number defaults to 22 if not specified.

TGT_BASTION_USER - The bastion host target user is only required if the user specified for the target zdmauth plug-in is different from the user of the target bastion host. The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

TGT_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

TGT_CONFIG_LOCATION specifies the SSH configuration file location on the Zero Downtime Migration service host (host where Zero Downtime Migration service is running).

Property Description

Syntax

TGT_CONFIG_LOCATION = SSH_config_file_path

Default value

User_home/.ssh/config

Usage Notes

Set TGT_CONFIG_LOCATION to the full path of the SSH configuration file location on the Zero Downtime Migration service host, for example, /home/crsuser/.ssh/config.

TGT_DATAACFS specifies the location for the data files ACFS volume (data) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_DATAACFS = data_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_DATADG specifies the location for the data files ASM disk group (data) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_DATADG = data_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_DB_UNIQUE_NAME is used by Zero Downtime Migration to identify the target database.

Property Description

Syntax

TGT_DB_UNIQUE_NAME = value of target database DB_UNIQUE_NAME

Default value

Usage Notes

Set TGT_DB_UNIQUE_NAME to the target database DB_UNIQUE_NAME value.

If the target database is Oracle Cloud Infrastructure, Exadata Cloud Service, or Exadata Cloud at Customer, the target database DB_UNIQUE_NAME parameter value must be unique to ensure that Oracle Data Guard can identify the target as a different database from the source database.

TGT_HOST_IP specifies the bastion user, if you want to connect to the target database server using a bastion host.

Property Description

Syntax

TGT_HOST_IP = IP_address

Default value

There is no default value.

Usage Notes

If you want to connect to the target database server using a bastion host, you are required to configure values for the bastion host IP address parameter, TGT_BASTION_HOST_IP, and the target database server IP address parameter, TGT_HOST_IP, in the Zero Downtime Migration response file.

If you do not want to use the default values for the remaining bastion connection parameters, set the following parameters to configure the bastion host connection.

TGT_BASTION_PORT - The port number defaults to 22 if not specified.

TGT_BASTION_USER - The bastion host target user is only required if the user specified for the target zdmauth plug-in is different from the user of the target bastion host. The bastion user defaults to the user specified for the target zdmauth plug-in if the parameter is not specified.

TGT_BASTION_IDENTITY_FILE - If not specified, the value defaults to the value specified for the identity_file argument of the target zdmauth plug-in.

TGT_HTTP_PROXY_PORT specifies the HTTPS proxy port if an SSH connection needs to use a proxy to connect to the target database server.

Property Description

Syntax

TGT_HTTP_PROXY_PORT = https_proxy_port_number

Default value

There is no default value.

Usage Notes

Set both the TGT_HTTP_PROXY_URL and TGT_HTTP_PROXY_PORT parameters if the SSH connection needs to use an HTTPS proxy to connect to the target database server.

TGT_HTTP_PROXY_URL specifies the HTTPS proxy URL if an SSH connection needs to use a proxy to connect to the target database server.

Property Description

Syntax

TGT_HTTP_PROXY_URL = https_proxy_url

Default value

There is no default value.

Usage Notes

Set both the TGT_HTTP_PROXY_URL and TGT_HTTP_PROXY_PORT parameters if the SSH connection needs to use an HTTPS proxy to connect to the target database server.

TGT_OSS_PROXY_HOST specifies the Object Storage Service proxy host on the target database server if a proxy is needed for connecting to the Object Store.

Property Description

Syntax

TGT_OSS_PROXY_HOST = oss_proxy_host

Default value

There is no default value.

Usage Notes

Set both the TGT_OSS_PROXY_HOST and TGT_OSS_PROXY_PORT parameters if a proxy is needed for connecting to the Object Store.

TGT_OSS_PROXY_PORT specifies the Object Storage Service proxy port number on the target database server if a proxy is needed for connecting to the Object Store.

Property Description

Syntax

TGT_OSS_PROXY_PORT = oss_proxy_port_number

Default value

There is no default value.

Usage Notes

Set both the TGT_OSS_PROXY_HOST and TGT_OSS_PROXY_PORT parameters if a proxy is needed for connecting to the Object Store.

TGT_RECOACFS specifies the location for the fast recovery area ACFS volume (reco) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_RECOACFS = reco_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_RECODG specifies the location for the fast recovery area ASM disk group (reco) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_RECODG = reco_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_REDOACFS specifies the location for redo log files ACFS volume (redo) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_REDOACFS = redo_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_REDODG specifies the location for redo log files ASM disk group (redo) on the target database. Use only if required to override the values discovered automatically by Zero Downtime Migration.

Property Description

Syntax

TGT_REDODG = redo_location

Default value

There is no default value.

Usage Notes

Zero Downtime Migration discovers the location for ASM and ACFS data, redo, and reco storage volumes from the specified target database, making these target database storage properties optional.

If you need to override the values automatically discovered by Zero Downtime Migration, then you can set the following parameters. For example, TGT_DATADG=+DATAC3

For ASM use these parameters

TGT_DATADG

TGT_REDODG

TGT_RECODG

For ACFS use these parameters

TGT_DATAACFS

TGT_REDOACFS

TGT_RECOACFS

TGT_RETAIN_DB_UNIQUE_NAME specifies whether to ship redo logs from Oracle Cloud to the on-premises standby, observe the environment for some time, and remove the fallback later.

When TGT_RETAIN_DB_UNIQUE_NAME=TRUE then the workflow phase ZDM_RETAIN_DBUNIQUENAME_TGT is present as the final phase. You must pause the migration job at a prior phase and resume the job when the fallback has to be removed.

Property Description

Syntax

TGT_RETAIN_DB_UNIQUE_NAME = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - enables this feature

FALSE - disables this feature

TGT_RMAN_CHANNELS specifies the number of RMAN channels to be allocated at the target database server for performing RMAN restore.

Property Description

Syntax

TGT_RMAN_CHANNELS = number_of_channels

Default value

10

TGT_SKIP_DATAPATCH specifies whether or not Zero Downtime Migration runs the datapatch utility on the target database as part of the post-migration tasks.

Property Description

Syntax

TGT_SKIP_DATAPATCH = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - do not allow Zero Downtime Migration to run datapatch

FALSE - allow Zero Downtime Migration to run datapatch

Usage Notes

If the target database environment is at a higher patch level than the source database (for example, if the source database is at Jan 2020 PSU/BP and the target database is at April 2020 PSU/BP), then set the TGT_SKIP_DATAPATCH parameter to FALSE to allow Zero Downtime Migration to run the datapatch utility on the target database as part of the post-migration tasks.

Otherwise, set the parameter to TRUE, and if the target database environment is at a higher patch level than the source database, you will need to run the datapatch utility manually after the migration.

TGT_SSH_RETRY_TIMEOUT specifies the number of minutes during which retries are attempted after SSH connection failures. Retries stop when the timeout value has elapsed.

Property Description

Syntax

TGT_SSH_RETRY_TIMEOUT = number_of_minutes

Default value

There is no default value.

TGT_SSH_TUNNEL_PORT specifies the forwarding port on the source database server where the SSH tunnel to the target database server for SQL*Net connection is set up.

Property Description

Syntax

TGT_SSH_TUNNEL_PORT = ssh_tunnel_port_number

Default value

There is no default value.

TGT_ZDLRA_WALLET_LOC specifies the path of the Zero Data Loss Recovery Appliance wallet on the target database server.

Property Description

Syntax

TGT_ZDLRA_WALLET_LOC = target_zdlra_wallet_location

The expected format for the location is /u02/app/oracle/product/12.1.0/dbhome_3/dbs/zdlra

Default value

There is no default value.

Usage Notes

When using Zero Data Loss Recovery Appliance as the migration backup medium, you must set the following parameters.

SRC_ZDLRA_WALLET_LOC

TGT_ZDLRA_WALLET_LOC

ZDLRA_CRED_ALIAS

ZDLRA_CRED_ALIAS specifies the Zero Data Loss Recovery Appliance wallet credential alias.

Property Description

Syntax

ZDLRA_CRED_ALIAS = zdlra_wallet_alias

The expected format for the alias is zdlra scan:listener port/zdlra9:dedicated

Default value

There is no default value.

Usage Notes

When using Zero Data Loss Recovery Appliance as the migration backup medium, you must set the following parameters.

SRC_ZDLRA_WALLET_LOC

TGT_ZDLRA_WALLET_LOC

ZDLRA_CRED_ALIAS

ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_BACKUP_DIFFERENTIAL_SRC migration job phase.

Property Description

Syntax

ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_BACKUP_FULL_SRC migration job phase.

Property Description

Syntax

ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_BACKUP_INCREMENTAL_SRC migration job phase.

Property Description

Syntax

ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_BACKUP_RETENTION_WINDOW specifies the number of days after which backups created by Zero Downtime Migration become obsolete.

Property Description

Syntax

ZDM_BACKUP_RETENTION_WINDOW = days

Default value

60

ZDM_BACKUP_TAG specifies an RMAN backup tag that can be used to perform a database migration or create a backup.

Use cases:

Set ZDM_USE_EXISTING_BACKUP=TRUE to use the specified RMAN backup in ZDM_BACKUP_TAG as the full backup, to skip the full backup phase in a migration job. An error is thrown if the backup associated with the specified tag is not valid.

Set ZDM_USE_EXISTING_BACKUP=FALSE if you wish to create a backup with the specified tag in ZDM_BACKUP_TAG

Property Description

Syntax

ZDM_BACKUP_TAG=RMAN backup tag

Default value

There is no default value

Range of values

Specify a valid RMAN backup tag to create or use an existing backup in the migration.

ZDM_CLONE_TGT_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_CLONE_TGT migration job phase.

Property Description

Syntax

ZDM_CLONE_TGT_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_CURL_LOCATION specifies a custom location for the CURL binary on the source.

Property Description

Syntax

ZDM_CURL_LOCATION = curl_location

Default value

/usr/bin/curl

ZDM_LOG_OSS_PAR_URL specifies the pre-authenticated URL to use when uploading logs to Object Storage Service. The logs capture the current migration job phase and the execution status of the phase.

Property Description

Syntax

ZDM_LOG_OSS_PAR_URL = url

Default value

There is no default value. By default this parameter is disabled.

ZDM_OPC_RETRY_COUNT specifies the number of retry attempts tat will be made after an initial Object Store connection failure.

Property Description

Syntax

ZDM_OPC_RETRY_COUNT = number

Default value

0 (zero)

The default behavior is to attempt no retries.

ZDM_OPC_RETRY_WAIT_TIME specifies the number of seconds to wait after an Object Store connection failure before attempting to retry the connection.

Property Description

Syntax

ZDM_OPC_RETRY_WAIT_TIME = seconds

Default value

529 (seconds)

ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_OSS_RECOVER_TGT migration job phase.

Property Description

Syntax

ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL specifies the time interval, in minutes, at which to monitor and report the progress of the ZDM_OSS_RESTORE_TGT migration job phase.

Property Description

Syntax

ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL = minutes

Default value

10

Usage Notes

The migration job phase monitoring interval parameters, listed below, monitor and report the backup and restore operations progress at the set time interval, specified in minutes. Note that the migration job phase for which the monitoring interval applies is prefixed to _MONITORING_INTERVAL in each parameter listed above.

  • ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL
  • ZDM_BACKUP_DIFFERENTIAL_SRC_MONITORING_INTERVAL
  • ZDM_CLONE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL
  • ZDM_OSS_RECOVER_TGT_MONITORING_INTERVAL

To disable a monitoring interval parameter, set it to 0 (zero).

Note that for parameters that are interval based, if the results are not in the job logs, check the specific phase logs for the monitoring information.

ZDM_RMAN_COMPRESSION_ALGORITHM specifies which RMAN compression algorithm to use for backups.

Property Description

Syntax

ZDM_RMAN_COMPRESSION_ALGORITHM ={BASIC | LOW | MEDIUM | HIGH}

Default value

MEDIUM

Range of values

BASIC - Does not require the Advanced Compression Option (ACO).

LOW - Least impact on backup throughput and suited for environments where CPU resources are the limiting factor.

MEDIUM - Recommended for most environments. Good combination of compression ratios and speed

HIGH - Best suited for backups over slower networks where the limiting factor is network speed

ZDM_RMAN_DIRECT_METHOD specifies the RMAN method (restore from service or active duplicate) to use when DATA_TRANSFER_MEDIUM=DIRECT data transfer method is specified.

You must also set the ZDM_SRC_DB_RESTORE_SERVICE_NAME parameter if you configure a physical migration using direct data transfer (DATA_TRANSFER_MEDIUM=DIRECT).

See Direct Data Transfer Support for more information about using direct data transfer in a physical migration

Property Description

Syntax

ZDM_RMAN_DIRECT_METHOD = {RESTORE_FROM_SERVICE | ACTIVE_DUPLICATE}

Default value

RESTORE_FROM_SERVICE

Range of values

  • RESTORE_FROM_SERVICE - Instantiates the standby target using RMAN restore from service. Restore from service is supported in Oracle Database 12.1 and later.
  • ACTIVE_DUPLICATE - Instantiates the standby target using RMAN active duplicate. Active duplicate is supported in Oracle Database 11gR2 and later.

ZDM_SHARD_ID is used to ensure that a migration job is running or is being resumed in the correct intended pod.

In a scenario where Zero Downtime Migration is scaled out to service multiple simultaneous migrations, each ZDM server has its own metadata store, which means that the same migration job ID values could be repeated across multiple ZDM servers.

To avoid job ID conflicts which could cause the incorrect job to be resumed on the incorrect ZDM server, the ZDM_SHARD_ID for each job will be configured contain the ZDM host name to which the migration job is being sent. This value will be seeded by E2E during RSP creation.

The value of ZDM_SHARD_ID and the other RSP tokens will be used by ZDM to confirm that the job metadata matches the RSP file values for the source and target database properties to ensure the correct job ID and ZDM server are resumed.

If the value from ZDM_SHARD_ID in the response file is set, and it does not match the current host name, the following exception is thrown:

PRGZ-#### : Specified shard ID zdm_host_name_a does not match with current ZDM host zdm_host_name_b.

in which den01gl is the value read from the response file, and den01glt is the current pod's host name

Property Description

Syntax

ZDM_SHARD_ID = zdm_host_name

Default value

No default value

By default, ZDM will not consider the host name before starting or resuming a job.

Range of values

ZDM_SHARD_ID accepts the host name of the pod in which the current job will be run or resumed. It accepts host name or fully qualified domain name.

The ZDM_SHARD_ID verification is case insensitive

ZDM_SKIP_DG_CONFIG_CLEANUP indicates whether Zero Downtime Migration should clean up the Oracle Data Guard configuration from the source and target databases at the end of the migration when using online physical migration.

Property Description

Syntax

ZDM_SKIP_DG_CONFIG_CLEANUP ={TRUE | FALSE}

Default value

FALSE

By default, ZDM will deconfigure Data Guard parameters configured for migration.

Range of values

TRUE - Do not clean up the Oracle Data Guard configuration.

FALSE - Clean up the Oracle Data Guard configuration.

ZDM_SRC_DB_RESTORE_SERVICE_NAME specifies the fully qualified name of the service on the source database to be used for an online physical migration (MIGRATION_METHOD=ONLINE_PHYSICAL) using direct data transfer (DATA_TRANSFER_MEDIUM=DIRECT).

You must also set the ZDM_RMAN_DIRECT_METHOD parameter if you configure a physical migration using direct data transfer (DATA_TRANSFER_MEDIUM=DIRECT).

See Direct Data Transfer Support for more information about using direct data transfer in a physical migration

Property Description

Syntax

ZDM_SRC_DB_RESTORE_SERVICE_NAME = source_database_service

Default value

There is no default value.

If not specified, the default database service is used.

ZDM_SRC_TNS_ADMIN specifies the custom location for TNS_ADMIN on the source database server when there is no Oracle Grid Infrastructure. If a Grid Infrastructure exists, then the TNS_ADMIN property must be set in the CRS resource attribute environment of the database resource.

Property Description

Syntax

ZDM_SRC_TNS_ADMIN = tns_admin_location

Default value

There is no default value.

Specifies the connect string of the standby database when ZDM_USE_EXISTING_STANDBY is enabled.

Property Description

Syntax

ZDM_STANDBY_DB_CONNECT_STRING = connect_string

Default value

None

Range of values

Enter the connect string for an existing standby for the source primary database

Indicates whether Zero Downtime Migration can use an Oracle Data Guard broker configuration to manage database role switchover.

Property Description

Syntax

ZDM_USE_DG_BROKER ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Use broker for the migration

FALSE - Do not use broker for the migration

ZDM_USE_EXISTING_BACKUP indicates whether Zero Downtime Migration can use an existing RMAN backup to perform a database migration.

If this parameter is set to TRUE, you must also set parameter ZDM_BACKUP_TAG. If no value is provided for ZDM_BACKUP_TAG, and ZDM_USE_EXISTING_BACKUP=TRUE an error is thrown.

Property Description

Syntax

ZDM_USE_EXISTING_BACKUP ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Use an existing RMAN backup for the migration

FALSE - Do not use an existing RMAN backup for the migration

Indicates whether Zero Downtime Migration can use an existing standby database to instantiate the standby in the target environment in a physical migration.

Optional parameters to set when ZDM_USE_EXISTING_STANDBY is enabled:

ZDM_STANDBY_DB_NAME

ZDM_STANDBY_DB_CONNECT_STRING

See Using an Existing Standby to Instantiate the Target Database.

Property Description

Syntax

ZDM_USE_EXISTING_STANDBY = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Use an existing standby for the migration

FALSE - Do not use a standby for the migration

ZDM_USE_EXISTING_UNDO_SIZE specifies whether Zero Downtime Migration should use the existing undo tablespace size when creating a new undo tablespace, if required.

Property Description

Syntax

ZDM_USE_EXISTING_UNDO_SIZE ={TRUE | FALSE}

Default value

TRUE

By default, Zero Downtime Migration uses the largest size of the existing undo tablespaces.

Range of values

TRUE - Use the existing undo tablespace size.

FALSE - Do not use the existing undo tablespace size.


Page 16

Zero Downtime Migration response file parameters supported for logical migrations.

Specifies how data will be transferred from the source database system to the target database system.

See also Configuring the Transfer Medium and Specifying Transfer Nodes

Property Description

Syntax

DATA_TRANSFER_MEDIUM = {OSS | NFS | DBLINK | COPY | AMAZON3}

Default value

OSS

Range of values

OSS - Object Storage Service

NFS - Network File System

DBLINK - Direct transfer of data over a database link

COPY - secure copy (for user-managed targets only)

AMAZON3 - Amazon Simple Storage Service (Amazon S3) bucket (only supported when SOURCEDATABASE_ENVIRONMENT_NAME=AMAZON

Required

Yes

Modifiable on Resume

No

Indicates whether to create a new OCI Auth Token.

If you are not using a network database link for Data Pump Import, an OCI Auth Token is created for the specified OCI user to import Data Pump dump files from the Object Storage into an Autonomous Database.

To reuse an existing Auth Token, set this property to FALSE.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_CREATEAUTHTOKEN ={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Creates an OCI Auth Token for the specified OCI user

FALSE - Does not create an OCI Auth Token.

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_TGT phase is COMPLETED.

Specifies the name of the database link from the OCI database to the on-premise database.

Zero Downtime Migration creates the database link if the link does not already exist.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

The DATAPUMPSETTINGS_DATABASELINKDETAILS_* parameters are optional details for creating a network database link from OCI database to the on-premise database.

Property Description

Syntax

DATAPUMPSETTINGS_DATABASELINKDETAILS_NAME = db_link_name

Default value

There is no default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_TGT phase is COMPLETED.

Specifies the OCI Object Storage bucket.

The DATAPUMPSETTINGS_DATABASELINKDETAILS_WALLETBUCKET_* parameters are used with Autonomous Database migration targets. These parameters settings specify the OCI Object Storage details used to store the wallet containing the certificate for on-premise database to create a database link from the Autonomous Database to the on-premise database using TLS.

Not required for a TCP connection from Autonomous Database to the on-premise database.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_DATABASELINKDETAILS_WALLETBUCKET_BUCKETNAME = Object Storage bucket name

Default value

There is no default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_TGT phase is COMPLETED.

Specifies the Object Storage namespace.

The DATAPUMPSETTINGS_DATABASELINKDETAILS_WALLETBUCKET_* parameters are used with Autonomous Database migration targets. These parameters settings specify the OCI Object Storage details used to store the wallet containing the certificate for on-premise database to create a database link from the Autonomous Database to the on-premise database using TLS.

Not required for a TCP connection from Autonomous Database to the on-premise database.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_DATABASELINKDETAILS_WALLETBUCKET_NAMESPACENAME = Object Storage bucket namespace

Default value

There is no default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_TGT phase is COMPLETED.

In lieu of a network database link, the OCI Object Storage bucket specified in DATAPUMPSETTINGS_DATABUCKET_BUCKETNAME is used to store Data Pump dump files for migrating to an Autonomous Database.

DATAPUMPSETTINGS_DATABUCKET_BUCKETNAME is one of the optional settings for logical migrations using Data Pump.

Use with DATAPUMPSETTINGS_DATABUCKET_NAMESPACENAME

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_DATABUCKET_BUCKETNAME = Name of the Object Storage bucket

Default value

There is no default value

Range of values

Enter the storage bucket name

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_SRC phase is COMPLETED.

In lieu of a network database link, the OCI Object Storage bucket specified with DATAPUMPSETTINGS_DATABUCKET_NAMESPACENAME is used to store Data Pump dump files for migrating to an Autonomous Database.

DATAPUMPSETTINGS_DATABUCKET_NAMESPACENAME is one of the optional settings for logical migrations using Data Pump.

Use with DATAPUMPSETTINGS_DATABUCKET_BUCKETNAME

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_DATABUCKET_NAMESPACENAME = Object Storage namespace

Default value

There is no default value

Range of values

Enter the storage bucket namespace

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_SRC phase is COMPLETED.

Specifies the STATISTICS method for Data Pump dump size estimation.

Zero Downtime Migration estimates the Data Pump dump size using the BLOCKS or STATISTICS methods. You are expected to apply discretion in arriving at the FILESYSTEM space required for the dump path, considering other factors that affect the actual dump size expected. The estimated dump size and actual size varies based on the data compression applied on the data in the database.

  • If data is compressed, then it would be the same as that of the reported ESTIMATE
  • If data is uncompressed, then Zero Downtime Migration exports with COMPRESSION set as MEDIUM and the resulting dump would be ~50% of estimate
  • There is deviation in dump size expected between data having HCC vs. Advanced compression modes

Note that by default, Zero Downtime Migration performs estimation using the BLOCKS method as part of the precheck and as part of the actual migration part of phase ZDM_DATAPUMP_ESTIMATE_SRC.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_ESTIMATEBYSTATISTICS = [TRUE | FALSE]

Default value

FALSE

Valid values

TRUE enables this parameter

FALSE disables this parameter

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_ESTIMATE_SRC phase is COMPLETED.

Specifies the action to be performed when data is loaded into a preexisting table.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_TABLEEXISTSACTION = [SKIP | TRUNCATE | REPLACE | APPEND]

Default value

SKIP

Range of values

SKIP - the preexisting table is left unchanged.

TRUNCATE - rows are removed from a preexisting table before inserting rows from the Import. Note that if TRUNCATE is specified on tables referenced by foreign key constraints, the TRUNCATE will be modified into a REPLACE.

REPLACE - preexisting tables are replaced with new definitions. Before creating the new table, the old table is dropped.

APPEND - new rows are added to the existing rows in the table

See TABLE_EXISTS_ACTION entry in Table 48-25 "Valid Options for the name Parameter in the SET_PARAMETER Procedure" in SET_PARAMETER Procedures

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_IMPORT_TGT phase is COMPLETED.

For EXPORT and Network IMPORT, if set to a nonzero value for schema-mode operations, specifies that the metadata to re-create the user's schemas should also be part of the operation.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETER_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_USERMETADATA = integer

Default value

There is no default value

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC is COMPLETED, or until ZDM_DATAPUMP_IMPORT_TGT phase when using DATA_TRANSFER_MEDIUM=DBLINK.

Specifies the maximum number of worker processes that can be used for a Data Pump Import job.

For migration to an Autonomous Database target, Zero Downtime Migration automatically queries its CPU core count and sets this parameter.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_IMPORTPARALLELISMDEGREE = integer

Default value

There is no default value

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_IMPORT_TGT phase is COMPLETED.

Specifies the maximum number of worker processes that can be used for a Data Pump Import job.

For migration to an Autonomous Database target, Zero Downtime Migration automatically queries its CPU core count and sets this parameter.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_EXPORTPARALLELISMDEGREE = integer

Default value

There is no default value

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC phase is COMPLETED.

Specifies a comma separated list of object types to exclude.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_EXCLUDETYPELIST = object_type_list

Default value

There is no default

Valid values

A comma separated list of object types

Required

No

Modifiable on Resume

No

Example

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_EXCLUDETYPELIST=cluster,dblink,comment

Specifies whether actions that were "in progress" on a previous execution of the job are skipped when the job restarts.

This mechanism allows you to skip actions that trigger fatal bugs and cause the premature termination of a job. Multiple actions can be skipped on a restart. The log file identifies which actions are skipped.

The skip is only honored for Import jobs.

If a domain index was being processed, all pieces of the domain index are skipped, even if the error only occurred in a sub-component of the domain index.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_SKIPCURRENT = [TRUE | FALSE]

Default value

FALSE

Valid values

TRUE enables this parameter

FALSE disables this parameter

Required

No

Modifiable in Resume

Until ZDM_DATAPUMP_IMPORT_TGT phase is COMPLETED.

Specifies whether all Data Pump workers are started on the current instance or on instances usable by the job.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_NOCLUSTER = [TRUE | FALSE]

Default value

FALSE

Valid values

TRUE all Data Pump workers are started on the current instance

FALSE Data Pump workers are started on instances usable by the job

Required

No

Modifiable on Resume

No

Specifies whether to retain the index.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_* are optional parameters for Data Pump Export and Import. See SET_PARAMETER Procedures for more information.

Property Description

Syntax

DATAPUMPSETTINGS_DATAPUMPPARAMETERS_RETAININDEX = [TRUE | FALSE]

Default value

FALSE

Valid values

TRUE retains the index

FALSE does not retain the index

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC phase is COMPLETED, or until ZDM_DATAPUMP_IMPORT_TGT phase when using DATA_TRANSFER_MEDIUM=DBLINK.

Indicates whether to retain dump files which are uploaded to Object Storage as part of the migration.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_DELETEDUMPSINOSS = {TRUE|FALSE}

Default value

TRUE

Range of values

TRUE = delete dumps

FALSE = retain dumps

Required

No

Modifiable on Resume

Until ZDM_POST_DATAPUMP_TGT phase is COMPLETED.

Specifies the object name of a directory on server file system of an on-premises database.

In lieu of a network database link, a directory on the server file system of an on-premises database, specified with the DATAPUMPSETTINGS_EXPORTDIRECTORYOBJECT_* properties is used to store Data Pump Export dump files.

Zero Downtime Migration creates this object if it does not already exist

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_EXPORTDIRECTORYOBJECT_NAME = Name

Default value

There is no default value

Range of values

Name of directory object in the database.

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_SRC phase is COMPLETED.

Specifies the object path of a directory on server file system of an on-premises database.

In lieu of a network database link, a directory on the server file system of an on-premises database, specified with the DATAPUMPSETTINGS_EXPORTDIRECTORYOBJECT_* properties is used to store Data Pump Export dump files.

Zero Downtime Migration creates this object if it does not already exist

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_EXPORTDIRECTORYOBJECT_PATH = Path

Default value

There is no default value

Range of values

Absolute path of directory on database server

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_SRC phase is COMPLETED.

Specifies whether invalid objects are recompiled in the database as part of the migration job.

Migration can result in invalid schema objects. Typically, invalid objects fix themselves as they are accessed or run. However, Oracle recommends that invalid objects are recompiled in the database as part of the Zero Downtime Migration migration job so that issues with invalid objects, and any required dependencies, are resolved before users encounter these invalid objects.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_FIXINVALIDOBJECTS = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE = fix invalid objects

FALSE = do not fix invalid objects

Required

No

Modifiable on Resume

Until ZDM_POST_DATAPUMP_TGT phase is COMPLETED.

Specifies the path of an import directory object.

In lieu of a network database link, a directory on the server file system of OCI database is used to store Data Pump dump files.

Zero Downtime Migration creates this object if it does not already exist.

For Autonomous Database migration targets, the DATA_PUMP_DIR object will already exist.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_IMPORTDIRECTORYOBJECT_PATH = Path of the directory object

Default value

There is no default value

Range of values

Absolute path of directory on database server

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_TGT phase is COMPLETED.

Specifies the name of an import directory object.

In lieu of a network database link, a directory on the server file system of OCI database is used to store Data Pump dump files.

Zero Downtime Migration creates this object if it does not already exist.

For Autonomous Database migration targets, the DATA_PUMP_DIR object will already exist.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_IMPORTDIRECTORYOBJECT_NAME = Name of the directory object

Default value

There is no default value

Range of values

Name of directory object in database

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_DATAPUMP_SETTINGS_TGT phase is COMPLETED.

Specifies the Data Pump export mode.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_JOBMODE = jobModeValue

Default value

SCHEMA

Range of values

FULL performs a full database export.

SCHEMA (default) lets you specify a set of schemas to export.

TABLE lets you specify a set of tables to export. In this mode, Zero Downtime Migration precreates the target schema before Data Pump import.

TABLESPACE lets you specify a set of tablespaces to export. In this mode, Zero Downtime Migration precreates the target schema before Data Pump import.

TRANSPORTABLE is not supported by Zero Downtime Migration.

See Oracle Data Pump Export Modes for more information.

Required

No

Modifiable on Resume

No

Defines the name, the object type, and the value of the filter for the Data Pump METADATA_FILTER property.

To add multiple filters, increment the integer appended to the parameter name, as shown in the examples below.

DATAPUMPSETTINGS_METADATAFILTERS-1=name:nameValue1st, objectType:objectTypeValue1st, value:valueValue1st DATAPUMPSETTINGS_METADATAFILTERS-2=name:nameValue2nd, objectType:objectTypeValue2nd, value:valueValue2nd

To exclude select SCHEMA Objects for FULL mode:

DATAPUMPSETTINGS_METADATAFILTERS-1=name:NAME_EXPR,value:'NOT IN(' 'SYSMAN' ')',objectType:SCHEMA DATAPUMPSETTINGS_METADATAFILTERS-2=name:NAME_EXPR,value:'NOT IN(' 'SH' ')',objectType:SCHEMA

Note that the SCHEMA name SYSMAN is surrounded by two single quotes and not a double quote.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_METADATAFILTERS-LIST_ELEMENT_NUMBER = name:nameValue, objectType:objectTypeValue, value:valueValue

Default value

There is no default value

Range of values

An entry specifying the name, type, and value is expected, as shown in the examples above.

Required

No

Modifiable on Resume

No

Defines remapping to be applied to objects as they are processed.

To add multiple remappings, increment the integer appended to the parameter name, as shown in the examples below.

DATAPUMPSETTINGS_METADATAREMAPS-1=type:typeValue1st, oldValue:oldValueValue1st, newValue:newValueValue1st DATAPUMPSETTINGS_METADATAREMAPS-2=type:typeValue2nd, oldValue:oldValueValue2nd, newValue:newValueValue2nd

See METADATA_REMAP Procedure for more information.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_METADATAREMAPS-LIST_ELEMENT_NUMBER = newValue:newValueValue, oldValue:oldValueValue, type:typeValue

Default value

There is no default value

Range of values

An entry specifying the new value, old value and type is expected, as shown in the examples above.

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC phase is COMPLETED, or until ZDM_DATAPUMP_IMPORT_TGT phase when using DATA_TRANSFER_MEDIUM=DBLINK

Defines the name, the object type, and the value for the Data Pump METADATA_TRANSFORM property.

To add multiple filters, increment the integer appended to the parameter name, as shown in the examples below.

DATAPUMPSETTINGS_METADATATRANSFORMS-1=name:nameValue1st, objectType:objectTypeValue1st, value:valueValue1st DATAPUMPSETTINGS_METADATATRANSFORMS-2=name:nameValue2nd, objectType:objectTypeValue2nd, value:valueValue2nd

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_METADATATRANSFORMS-LIST_ELEMENT_NUMBER = name:nameValue, objectType:objectTypeValue, value:valueValue

Default value

There is no default value

Range of values

An entry specifying the name, type, and value is expected, as shown in the examples above.

Required

No

Modifiable on Resume

No

Specifies the Data Pump monitor interval in minutes. This setting is optional.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_MONITORINTERVALMINUTES = number

Default value

10

Range of values

An integer value is expected

Required

No

Modifiable on Resume

No

Sets TRANSFORM=OMIT_ENCRYPTION_CLAUSE, which directs Data Pump to suppress any encryption clauses associated with objects using encrypted columns.

This parameter is valid for targets on Oracle Database 19c and later releases.

OMIT_ENCRYPTION_CLAUSE applies to materialized view, table, and tablespace objects, and enables objects which were using encrypted columns in the source to get created in a target database environment where encryption attributes are not supported.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_OMITENCRYPTIONCLAUSE = [TRUE | FALSE]

Default value

TRUE

Valid values

TRUE enables this parameter

FALSE disables this parameter

Required

No

Modifiable on Resume

No

Sets TRANSFORM=LOB_STORAGE:SECUREFILE, which directs Data Pump to transform basic LOBs into securefile LOBs during the Data Pump import.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_SECUREFILELOB = [TRUE | FALSE]

Default value

TRUE

Valid values

TRUE enables this parameter

FALSE disables this parameter

Required

No

Modifiable on Resume

No

Specifies the number of schemas to be processed in parallel as batches.

When DATAPUMPSETTINGS_JOBMODE=SCHEMA you can specify the number of schemas to be migrated in parallel. If this count is specified, then Zero Downtime Migration determines the set of schemas included in each batch from the list of user schemas identified from the database.

DATAPUMPSETTINGS_SCHEMABATCHCOUNT is mutually exclusive with the DATAPUMPSETTINGS_SCHEMABATCH parameter.

Property Description

Syntax

DATAPUMPSETTINGS_SCHEMABATCHCOUNT = integer

Default value

There is no default value

Range of values

An integer equal to or less than database initialization parameter MAX_DATAPUMP_JOBS_PER_PDB

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_SRC phase is COMPLETED

Specifies which schemas are batched together to be migrated in parallel.

When DATAPUMPSETTINGS_JOBMODE=SCHEMA you can specify which schemas are migrated together in parallel as a batch. Increment the -LIST_ELEMENT_NUMBER value to differentiate the batches.

In this example there are two batches, each containing two schemas that are migrated in parallel.

DATAPUMPSETTINGS_SCHEMABATCH-1=n1,n2

DATAPUMPSETTINGS_SCHEMABATCH-2=n3,n4

DATAPUMPSETTINGS_SCHEMABATCH is mutually exclusive with the DATAPUMPSETTINGS_SCHEMABATCHCOUNT parameter.

Property Description

Syntax

DATAPUMPSETTINGS_SCHEMABATCH-LIST_ELEMENT_NUMBER = list of schemas

Default value

There is no default value.

Range of values

LIST_ELEMENT_NUMBER must be a unique integer value for each batch specified

list of schemas must be a comma-separated list of schemas

Required

No

Modifiable on Resume

Until ZDM_VALIDATE_SRC phase is COMPLETED

Skips default transform parameters.

Set this property to TRUE to avoid all internal Zero Downtime Migration transform defaults.

Parameter Relationships

The optional DATAPUMPSETTINGS_* parameters let you customize Oracle Data Pump Export and Import jobs.

Property Description

Syntax

DATAPUMPSETTINGS_SKIPDEFAULTTRANSFORM = [TRUE | FALSE]

Default value

FALSE

Valid values

TRUE enables this parameter

FALSE disables this parameter

Required

No

Modifiable on Resume

No

Specifies the maximum number of Export dump files to transfer to Object Storage or remote node in parallel.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

Property Description

Syntax

DUMPTRANSFERDETAILS_PARALLELCOUNT = integer

Default value

3

Range of values

This parameter accepts integer values

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the number of times to retry upload or transfer of dump failure.

Intermittent network failures observed during the transfer of Data Pump dumps can mitigated by setting the DUMPTRANSFERDETAILS_RETRYCOUNT parameter.

Parameter Relationships

The DUMPTRANSFERDETAILS parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

Property Description

Syntax

DUMPTRANSFERDETAILS_RETRYCOUNT = integer

Default value

3

Range of values

This parameter accepts integer values

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies that the transfer dump files are using the Linux rsync utility.

Ensure rsync is installed in both source and target servers. Oracle Exadata does not ship with rsync, refer to MOS Doc ID 1556257.1 for details. ZDM defaults to scp command for transfer.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

Property Description

Syntax

DUMPTRANSFERDETAILS_RSYNCAVAILABLE = {TRUE | FALSE

Default value

FALSE

Range of values

TRUE - transfer dump files are using the Linux rsync utility

FALSE - not using rsync

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the access key of the Amazon Simple Storage Service (Amazon S3) bucket.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Property Description

Syntax

DUMPTRANSFERDETAILS_S3BUCKET_ACCESSKEY = s3_bucket_access_key

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the name of the Amazon Simple Storage Service (Amazon S3) bucket.

When you set DATA_TRANSFER_MEDIUM=AMAZON3 to migrate an Amazon Web Services RDS Oracle database to Oracle Autonomous Database using an S3 bucket, you must also set the DUMPTRANSFERDETAILS_S3BUCKET_* parameters.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Property Description

Syntax

DUMPTRANSFERDETAILS_S3BUCKET_NAME = s3_bucket_name

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the region of the Amazon Simple Storage Service (Amazon S3) bucket.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Property Description

Syntax

DUMPTRANSFERDETAILS_S3BUCKET_REGION = s3_bucket_region

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the Oracle Cloud OCI-CLI Binary path.

Parameter Relationships

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_OCIHOME = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the part size in MB for chunked transfer.

Parameter Relationships

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_PARTSIZEMB = integer

Default value

128

Range of values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the absolute path of the directory to copy or upload dump files.

The DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using Oracle Cloud OCI-CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node. Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_DUMPDIRPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the dump transfer node host name.

The DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using Oracle Cloud OCI-CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node. Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_HOST = host_name

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the Sudo path on the dump transfer node.

The DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using Oracle Cloud OCI-CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node. Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_SUDOPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the user allowed to execute OCI CLI in the dump transfer node.

The DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using Oracle Cloud OCI-CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_USER = user

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the user's authentication key.

The DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using Oracle Cloud OCI-CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node. Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_TRANSFERNODE_USERKEY = user_auth_key

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Indicates that transfer dump files use Oracle Cloud Infrastructure command line interface (CLI).

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_SOURCE_* parameters specify details to upload the Dump files from source node Data Pump dump location to Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_SOURCE_USEOCICLI = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE or FALSE

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the Oracle Cloud Infrastructure command line interface (CLI) Binary path.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_OCIHOME = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the part size in MB for chunked transfer.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_PARTSIZEMB = integer

Default value

128

Range of values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the absolute path of the directory to copy or upload dump files.

The DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using the OCI CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through Oracle Cloud Infrastructure command line interface (CLI) or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_DUMPDIRPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the dump transfer node host name.

The DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using OCI CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through Oracle Cloud Infrastructure command line interface (CLI) or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_HOST = host_name

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the Sudo path on the dump transfer node.

The DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using OCI CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through Oracle Cloud Infrastructure command line interface (CLI) or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_SUDOPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the user allowed to execute OCI CLI in the dump transfer node.

The DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using OCI CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node. Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through Oracle Cloud Infrastructure command line interface (CLI) or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_USER = user

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the user's authentication key.

The DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_* parameters are configured when you use a standalone server as transfer server.

Transfer dump files using OCI CLI or curl, or copy to or from a node other than the database server.

This option can be leveraged for cases where OCI CLI is installed and configured in a specific node per data center and the node has the Data Pump export or import directory path shared with it. This avoids the requirement of installing OCI CLI on the database node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through Oracle Cloud Infrastructure command line interface (CLI) or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_TRANSFERNODE_USERKEY = user_auth_key

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Indicates that transfer dump files use Oracle Cloud Infrastructure command line interface (CLI).

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TARGET_* parameters specify details to download the Dump files to the target node Data Pump dump location from Oracle Cloud Object Storage.

Property Description

Syntax

DUMPTRANSFERDETAILS_TARGET_USEOCICLI = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE or FALSE

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the absolute path of the directory to copy or upload dump files.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TRANSFERTARGET_* parameters specify details for the target node to copy the Dump files from source node Data Pump dump location or transfer node directory path specified. Default target database host.

Property Description

Syntax

DUMPTRANSFERDETAILS_TRANSFERTARGET_DUMPDIRPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

DUMPTRANSFERDETAILS_TRANSFERTARGET_HOST specifies the dump transfer node host name.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TRANSFERTARGET_* parameters specify details for the target node to copy the Dump files from source node Data Pump dump location or transfer node directory path specified. Default target database host.

Property Description

Syntax

DUMPTRANSFERDETAILS_TRANSFERTARGET_HOST = host_name

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the Sudo path on the dump transfer node.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TRANSFERTARGET_* parameters specify details for the target node to copy the Dump files from source node Data Pump dump location or transfer node directory path specified. Default target database host.

Property Description

Syntax

DUMPTRANSFERDETAILS_TRANSFERTARGET_SUDOPATH = path

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the host user name that has write permission to the indicated dump storage path.

The user specified in DUMPTRANSFERDETAILS_TRANSFERTARGET_USER should be allowed to

  • Execute OCI CLI in the specified host to download the dumps from the Object Storage bucket if DATA_TRANSFER_MEDIUM=OSS

  • Copy the dump files from the source node to the target host specified if DATA_TRANSFER_MEDIUM=COPY.

See Configuring the Transfer Medium and Specifying Transfer Nodes for more information about configuring the dump transfer details parameters.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TRANSFERTARGET_* parameters specify details for the target node to copy the Dump files from source node Data Pump dump location or transfer node directory path specified. Default target database host.

Property Description

Syntax

DUMPTRANSFERDETAILS_TRANSFERTARGET_USER = host_username

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies the user's authentication key.

Parameter Relationships

The DUMPTRANSFERDETAILS_* parameters specify details to transfer dumps from the source node to the target node.

Supported modes of transfer are OSS and secure copy. Upload of dumps to OSS can be either through OCI CLI or Curl.

The DUMPTRANSFERDETAILS_TRANSFERTARGET_* parameters specify details for the target node to copy the Dump files from source node Data Pump dump location or transfer node directory path specified. Default target database host.

Property Description

Syntax

DUMPTRANSFERDETAILS_TRANSFERTARGET_USERKEY = user_auth_key

Default value

No default value

Range of values

A string value is expected

Required

No

Modifiable on Resume

Until ZDM_TRANSFER_DUMPS_SRC phase is COMPLETED

Specifies database objects to exclude from migration.

To exclude multiple objects, increment the integer appended to the parameter name, as shown in the examples below.

EXCLUDEOBJECTS-1=owner:ownerValue1, objectName:objectNameValue1, objectType:objectTypeValue1

EXCLUDEOBJECTS-2=owner:ownerValue2, objectName:objectNameValue2, objectType:objectTypeValue2

See Selecting Objects for Migration for more information about using EXCLUDEOBJECTS.

Property Description

Syntax

EXCLUDEOBJECTS-LIST_ELEMENT_NUMBER = owner:ownerValue, objectName:objectNameValue, objectType:objectTypeValue

Default value

There is no default value.

Range of values

An entry specifying the owner, object name, and object type is expected, as shown in the examples above.

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC phase is COMPLETED, or until ZDM_DATAPUMP_IMPORT_TGT phase when using DATA_TRANSFER_MEDIUM=DBLINK.

Specifies the GoldenGate hub administrator user name.

Parameter Relationships

For online logical migration, you must set the GOLDENGATEHUB_* parameters to provide Zero Downtime Migration with details about Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATEHUB_ADMINUSERNAME = user_name

Default value

There is no default value

Range of values

Oracle GoldenGate hub's administrator user name

Required

No*

*Required for online logical migration

Modifiable on Resume

Until ZDM_PREPARE_GG_HUB phase is COMPLETED.

Specifies the Oracle Cloud identifier of the VM.

Parameter Relationships

For online logical migration, you must set the GOLDENGATEHUB_* parameters to provide Zero Downtime Migration with details about Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATEHUB_COMPUTEID = vm_identifier

Default value

There is no default value

Range of values

Oracle Cloud identifier of the VM

Required

No*

*Required for online logical migration

Modifiable on Resume

Until ZDM_PREPARE_GG_HUB phase is COMPLETED.

Specifies the name of the GoldenGate Microservices deployment to operate on the source database.

Parameter Relationships

For online logical migrations, you must set the GOLDENGATEHUB parameters to provide Zero Downtime Migration with details about Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATEHUB_SOURCEDEPLOYMENTNAME = GG_microservices_deployment_name

Default value

There is no default value

Range of values

Name of the GoldenGate Microservices deployment to operate on the source database

Required

No*

*Required for online logical migration

Modifiable on Resume

Until ZDM_PREPARE_GG_HUB phase is COMPLETED.

Specifies the name of the GoldenGate Microservices deployment to operate on the target database.

Parameter Relationships

For online logical migrations, you must set the GOLDENGATEHUB parameters to provide Zero Downtime Migration with details about Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATEHUB_TARGETDEPLOYMENTNAME = GG_microservices_deployment_name

Default value

There is no default value

Range of values

Name of the GoldenGate Microservices deployment to operate on the target database

Required

No*

*Required for online logical migration

Modifiable on Resume

Until ZDM_PREPARE_GG_HUB phase is COMPLETED.

Specifies the Oracle GoldenGate hub's REST endpoint.

Parameter Relationships

For online logical migrations, you must set the GOLDENGATEHUB parameters to provide Zero Downtime Migration with details about Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATEHUB_URL = GG_hub_rest_endpoint

Default value

There is no default value

Range of values

Oracle GoldenGate hub's REST endpoint

Required

No*

*Required for online logical migration

Modifiable on Resume

Until ZDM_PREPARE_GG_HUB phase is COMPLETED.

Specifies GoldenGate end-to-end latency lag time

Zero Downtime Migration monitors GoldenGate end-to-end latency until the lag time is lower than the value (in seconds) specified in GOLDENGATESETTINGS_ACCEPTABLELAG.

Parameter Relationships

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_ACCEPTABLELAG = seconds

Default value

30 seconds

Required

No

Required

No

Modifiable on Resume

Until ZDM_MONITOR_GG_LAG phase is COMPLETED.

Tunes Oracle GoldenGate Integrated Capture.

Use this setting to automatically configure relevant parameters to achieve the desired throughput and latency.

Parameter Relationships

The GOLDENGATESETTINGS_EXTRACT_* parameters define settings for the Integrated Extract process.

Only one Extract can be configured.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_EXTRACT_PERFORMANCEPROFILE = [HIGH | MEDIUM | LOW_RES]

Default value

HIGH

Valid values

HIGH, MEDIUM, LOW_RES

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_EXTRACT_SRC phase is COMPLETED.

Specifies the frequency in seconds with which Oracle GoldenGate checks for long-running transactions.

Parameter Relationships

GOLDENGATESETTINGS_EXTRACT_WARNLONGTRANS_* parameters specify a length of time in seconds that a transaction can be open before Extract generates a warning message that the transaction is long-running.

The GOLDENGATESETTINGS_EXTRACT_* parameters define settings for the Integrated Extract process.

Only one Extract can be configured.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_EXTRACT_WARNLONGTRANS_CHECKINTERVAL = integer

Default value

There is no default value

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_EXTRACT_SRC phase is COMPLETED.

Specifies a length of time in seconds that a transaction can be open before the GoldenGate Extract process generates a warning message that the transaction is long-running.

Parameter Relationships

GOLDENGATESETTINGS_EXTRACT_WARNLONGTRANS_* parameters specify a length of time in seconds that a transaction can be open before Extract generates a warning message that the transaction is long-running.

The GOLDENGATESETTINGS_EXTRACT_* parameters define settings for the Integrated Extract process.

Only one Extract can be configured.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_EXTRACT_WARNLONGTRANS_DURATION = integer

Default value

There is no default value

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_EXTRACT_SRC phase is COMPLETED.

Specifies the number of threads used to read GoldenGate trail files.

Valid for Parallel Replicat.

Parameter Relationships

The GOLDENGATESETTINGS_REPLICAT_* parameters define settings for the Parallel Replicat process.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_REPLICAT_MAPPARALLELISM = integer

Default value

4

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_REPLICAT_TGT phase is COMPLETED.

Defines the range in which the GoldenGate Replicat automatically adjusts its apply parallelism.

Valid for Parallel Replicat.

Parameter Relationships

The GOLDENGATESETTINGS_REPLICAT_* parameters define settings for the Parallel Replicat process.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_REPLICAT_MAXAPPLYPARALLELISM = integer

Default value

50

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_REPLICAT_TGT phase is COMPLETED.

Defines the range in which the GoldenGate Replicat automatically adjusts its apply parallelism.

Valid for Parallel Replicat.

Parameter Relationships

The GOLDENGATESETTINGS_REPLICAT_* parameters define settings for the Parallel Replicat process.

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_REPLICAT_MINAPPLYPARALLELISM = integer

Default value

4

Valid values

An integer value is expected

Required

No

Modifiable on Resume

Until ZDM_CREATE_GG_REPLICAT_TGT phase is COMPLETED.

Specifies whether to set Oracle GoldenGate Extract parameter DDLOPTIONS CAPTUREGLOBALTEMPTABLE.

DDL replication: If you set parameter GOLDENGATESETTINGS_REPLICATEDDL = TRUE, then Zero Downtime Migration sets Oracle GodenGate Extract parameter DDLOPTIONS CAPTUREGLOBALTEMPTABLE.

Parameter Relationships

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_REPLICATEDDL = TRUE | FALSE

Default value

FALSE

Required

No

Modifiable on Resume

Specifies whether to set Oracle GoldenGate Extract parameters that allow ID KEY support mode objects to be replicated.

If you set parameter GOLDENGATESETTINGS_USEFLASHBACKQUERY = TRUE, Zero Downtime Migration sets the following Oracle GoldenGate Extract parameters that allow ID KEY support mode objects to be replicated.

Parameter Relationships

For online logical migrations, you can set the optional GOLDENGATESETTINGS_* parameters to provide Zero Downtime Migration with details about the Oracle GoldenGate Microservices configuration.

Property Description

Syntax

GOLDENGATESETTINGS_USEFLASHBACKQUERY = TRUE | FALSE

Default value

FALSE

Required

No

Modifiable on Resume

Specifies database objects to include for migration.

To include multiple objects, increment the integer appended to the parameter name, as shown in the examples below.

INCLUDEOBJECTS-1=owner:ownerValue1, objectName:objectNameValue1, objectType:objectTypeValue1

INCLUDEOBJECTS-2=owner:ownerValue2, objectName:objectNameValue2, objectType:objectTypeValue2

See Selecting Objects for Migration for more information about using INCLUDEOBJECTS.

Property Description

Syntax

INCLUDEOBJECTS-LIST_ELEMENT_NUMBER = owner:ownerValue, objectName:objectNameValue, objectType:objectTypeValue

Default value

There is no default value

Range of values

An entry specifying the owner, object name, and object type is expected, as shown in the examples above.

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_EXPORT_SRC phase is COMPLETED, or until ZDM_DATAPUMP_IMPORT_TGT phase when using DATA_TRANSFER_MEDIUM=DBLINK.

In a logical migration, specifies whether the migration is online logical or offline logical

The required MIGRATION_METHOD parameter specifies whether the migration is online (Data Pump with Oracle GoldenGate replication) or offline (Data Pump only).

Property Description

Syntax

MIGRATION_METHOD = {ONLINE_LOGICAL | OFFLINE_LOGICAL}

Default value

OFFLINE_LOGICAL

Range of values

ONLINE_LOGICAL migrate the database with Data Pump, with replication using Oracle GoldenGate for minimal downtime

OFFLINE_LOGICAL migrate the database with Data Pump, with no replication

Required

Yes

Modifiable on Resume

No

Specifies the OCI region identifier.

Parameter Relationships

To call REST APIs, you must configure the OCIAUTHENTICATIONDETAILS_* parameters.

Property Description

Syntax

OCIAUTHENTICATIONDETAILS_REGIONID = region_id

Default value

There is no default value

Required

Yes

Modifiable on Resume

Yes

Specifies the fingerprint of the public API key.

See Required Keys and OCIDs for more information.

Parameter Relationships

To call REST APIs, you must configure the OCIAUTHENTICATIONDETAILS_* parameters.

Property Description

Syntax

OCIAUTHENTICATIONDETAILS_USERPRINCIPAL_FINGERPRINT = fingerprint

Default value

There is no default value

Required

Yes

Modifiable on Resume

Yes

Specifies the absolute path of API private key file.

See Required Keys and OCIDs for more information.

Parameter Relationships

To call REST APIs, you must configure the OCIAUTHENTICATIONDETAILS_* parameters.

Property Description

Syntax

OCIAUTHENTICATIONDETAILS_USERPRINCIPAL_PRIVATEKEYFILE = path

Default value

There is no default value

Required

Yes

Modifiable on Resume

Yes

Specifies the OCID of the OCI tenancy.

You can find the tenant OCID on OCI at Governance and Administration, Administration, Tenancy Details. The tenancy OCID is shown under Tenancy Information.

Example: ocid1.tenancy.oc1..aaaaaaaaba3pv6wkcr4jqae5f44n2b2m2yt2j6rx32uzr4h25vqstifsfdsq

See Managing the Tenancy and Required Keys and OCIDs for more information.

Parameter Relationships

To call OCI REST APIs, you must configure the OCIAUTHENTICATIONDETAILS_* parameters.

Property Description

Syntax

OCIAUTHENTICATIONDETAILS_USERPRINCIPAL_TENANTID = ocid_string

Default value

There is no default value

Valid values

A string value is expected

Required

Yes

Modifiable on Resume

Yes

Specifies the OCID of the IAM user.

Parameter Relationships

To call OCI REST APIs, you must configure the OCIAUTHENTICATIONDETAILS_* parameters.

Property Description

Syntax

OCIAUTHENTICATIONDETAILS_USERPRINCIPAL_USERID = userid

Default value

There is no default value

Required

Yes

Modifiable on Resume

Yes

Specifies the HTTP proxy host name.

Parameter Relationships

The OCIPROXY_* parameters specify details about the proxy for connecting to OCI REST endpoints.

Property Description

Syntax

OCIPROXY_HOSTNAME = hostname

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the HTTP proxy port number.

Parameter Relationships

The OCIPROXY_* parameters specify details about the proxy for connecting to OCI REST endpoints.

Property Description

Syntax

OCIPROXY_PORT = port number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies whether Cloud Premigration Advisor Tool (CPAT) should run on the Zero Downtime Migration service host with a remote connection to the source database.

See Running CPAT with a Remote Connection for details.

Property Description

Syntax

RUNCPATREMOTELY = {TRUE | FALSE}

Default value

FALSE

Range of values

TRUE = run CPAT remotely

FALSE = do not run CPAT remotely

Required

No

Modifiable on Resume

No

Specifies the source CDB administrator user name.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_* parameters specify connection details for the source database CDB root.

Property Description

Syntax

SOURCECONTAINERDATABASE_ADMINUSERNAME = username

Default value

There is no default value

Required

No

Modifiable on Resume

No

Specifies the identity file to access the bastion, as part of the database connection details for bastion-based access to the database.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_* parameters specify details for bastion based access to the database.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IDENTITYFILE = bastion_id_file

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the IP address of the source CDB bastion host, as part of the database connection details for bastion-based access to the database.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_* parameters specify details for bastion based access to the database.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IP = bastion_ip_address

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the bastion host port, as part of the database connection details for bastion-based access to the container database (CDB).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_* parameters specify details for bastion based access to the database.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_PORT = bastion_port_number

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the remote host IP address to access from the bastion, as part of the database connection details for bastion-based access to the container database (CDB).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_* parameters specify details for bastion based access to the database.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_REMOTEHOSTIP = ip_address

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the user name to access the bastion, as part of the database connection details for bastion-based access to the container database (CDB).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_* parameters specify details for bastion based access to the database.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_USERNAME = username

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the listener host name or IP address for the source container database (CDB).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_HOST = listener_host

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required for migrations to Autonomous Database.

Modifiable on Resume

Yes

Specifies the listener port number for the source container database (CDB).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_PORT = listener_port

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required for migrations to Autonomous Database.

Modifiable on Resume

Yes

Specifies the HTTPS proxy host name for the CDB.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_PROXYDETAILS_* parameters specify connection details for the source CDB root through an HTTP proxy.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_PROXYDETAILS_HOSTNAME = proxy_hostname

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the HTTPS proxy host port number for the CDB.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_PROXYDETAILS_* parameters specify connection details for the source CDB root through an HTTP proxy.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_PROXYDETAILS_PORT = proxy_port

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the fully qualified source CDB service name.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_* parameters specify connection details for the source database CDB root.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_SERVICENAME = service_name

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required for Autonomous Database

Modifiable on Resume

No

Specifies the directory containing client credentials (wallet, keystore, trustfile, etc.) for the CDB.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_TLSDETAILS_* parameters specify details for TLS connection to the database CDB. These settings are not required if you are using TCP.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_TLSDETAILS_CREDENTIALSLOCATION = directory

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required for Autonomous Database

Not required if you are using TCP

Modifiable on Resume

Yes

Specifies the distinguished name (DN) of the database server (SSL_SERVER_CERT_DN).

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source CDB root.

The SOURCECONTAINERDATABASE_CONNECTIONDETAILS_TLSDETAILS_* parameters specify details for TLS connection to the CDB. These settings are not required if you are using TCP.

Property Description

Syntax

SOURCECONTAINERDATABASE_CONNECTIONDETAILS_TLSDETAILS_DISTINGUISHEDNAME = distinguished_name

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required for Autonomous Database

Not required if you are using TCP

Modifiable on Resume

Yes

Specifies the source CDB GoldenGate administrator user name.

Parameter Relationships

For online logical migrations, the SOURCECONTAINERDATABASE_* parameters specify connection details for the source database CDB root.

Property Description

Syntax

SOURCECONTAINERDATABASE_GGADMINUSERNAME = GoldenGate administrator username

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

No

Specifies the source database administrator user name.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_ADMINUSERNAME = source administrator username

Default value

There is no default value

Required

Yes

Modifiable on Resume

No

Specifies the identity file to access the bastion for bastion-based access to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IDENTITYFILE = identity file

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the IP address of the bastion host for bastion-based access to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IP = ip address

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the port number of the bastion host for bastion-based access to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_PORT = port_number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the remote host IP address to access from the bastion for bastion-based access to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_REMOTEHOSTIP = ip_address

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the user name to access the bastion for bastion-based access to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_USERNAME = username

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the source database listener host name or IP address.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_HOST = hostname_or_ip

Default value

There is no default value

Required

Yes*

*Not required for Autonomous Database.

Modifiable on Resume

Yes

Specifies the source database listener port number.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_PORT = listener port number

Default value

There is no default value

Required

Yes*

*Not required for Autonomous Database.

Modifiable on Resume

Yes

Specifies the proxy host name to connect to the source database through an HTTPS proxy.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_PROXYDETAILS_HOSTNAME = proxy host name

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the HTTP proxy port number to connect to the source database through an HTTPS proxy.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_PROXYDETAILS_PORT = proxy port number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the source database fully qualified service name.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_SERVICENAME = service name

Default value

There is no default value

Required

Yes*

*Not required for Autonomous Database

Modifiable on Resume

No

Specifies the directory containing client credentials (wallet, keystore, trustfile, etc.) for a TLS connection to the database.

Parameter Relationships

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_TLSDETAILS_CREDENTIALSLOCATION = directory

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required if using TCP

Not required for Autonomous Database

Modifiable on Resume

Yes

Specifies the distinguished name (DN) of the database server (SSL_SERVER_CERT_DN) for a TLS connection to the database.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

The SOURCEDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_CONNECTIONDETAILS_TLSDETAILS_DISTINGUISHEDNAME = distinguished_name

Default value

There is no default value

Required

Not mandatory for migration jobs

Not required if using TCP

Not required for Autonomous Database

Modifiable on Resume

Yes

Indicates the type of database to migrate from the specified environment.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_ENVIRONMENT_DBTYPE = RDS_ORACLE

Default value

RDS_ORACLE

Required

No

Modifiable on Resume

No

Specifies the environment of the source database.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_ENVIRONMENT_NAME = [ORACLE|AMAZON]

Default value

ORACLE

Required

No

Modifiable on Resume

No

Specifies the GoldenGate administrator user name for online logical migrations.

Parameter Relationships

The SOURCEDATABASE_* parameters specify connection details for the source database.

Property Description

Syntax

SOURCEDATABASE_GGADMINUSERNAME = gg_admin_username

Default value

There is no default value

Required

No

Modifiable on Resume

No

Specifies whether Zero Downtime Migration automatically creates tablespaces at the target database necessary to allocate space in the database to contain schema objects.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_AUTOCREATE={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Zero Downtime Migration automatically creates tablespaces

FALSE - Zero Downtime Migration does not create tablespaces

Required

No

This option is prohibited for Autonomous Database Shared targets.

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED

Specifies whether Zero Downtime Migration automatically remaps a tablespace at the target database.

See Automatic Tablespace Remap for more information.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_AUTOREMAP={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Zero Downtime Migration automatically remaps tablespaces

FALSE - Zero Downtime Migration does not remap tablespaces

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_IMPORT_TGT phase is COMPLETED

Specifies tablespaces to be excluded from automatic creation at the target database.

See Automatic Tablespace Creation for more information.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_EXCLUDE=tablespace_names

Default value

By default SYSTEM, SYSAUX, and USERS tablespaces are excluded.

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED

Specifies an extend size for AUTOEXTEND in support of automatic tablespace creation.

Properly setting TABLESPACEDETAILS_EXTENDSIZEMB enables AUTOEXTEND to avoid extend errors when automatic tablespace creation is enabled.

See Automatic Tablespace Creation for more information.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_EXTENDSIZEMB=MB

Default value

512

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED

Specifies tablespaces to be remapped.

For a tablespace to be used as REMAP target, the user performing the import operation, for example SYSTEM, should have some quota on the chosen tablespace.

See Automatic Tablespace Remap for more information.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_REMAPTARGET=target_tablespace_names

Default value

By default the DATA tablespace is remapped.

Required

No

Modifiable on Resume

Until ZDM_DATAPUMP_IMPORT_TGT phase is COMPLETED

Specifies whether to use bigfile tablespaces, if Zero Downtime Migration is configured to create tablespaces automatically.

Using bigfile tablespaces, which can be up to 128 TB, significantly reduces the number of data files for your database. Combined with Oracle Managed Files (OMF), bigfile tablespaces simplify data file management.

See Automatic Tablespace Creation for more information.

Parameter Relationships

In a logical migration, the TABLESPACEDETAILS_* parameters specify details that allow Zero Downtime Migration to automatically create the required tablespaces at target database..

Property Description

Syntax

TABLESPACEDETAILS_USEBIGFILE={TRUE | FALSE}

Default value

FALSE

Range of values

TRUE - Zero Downtime Migration automatically creates bigfile tablespaces

FALSE - Zero Downtime Migration does not create bigfile tablespaces

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED

Specifies the target database administrator user name.

Parameter Relationships

The TARGETDATABASE_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_ADMINUSERNAME = username

Default value

There is no default value

Required

Yes

Modifiable on Resume

No

Specifies the identity file to access the bastion for bastion-based access to the target database.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IDENTITYFILE = bastion_id_file

Default value

There is no default value

Required

Not mandatory for migration jobs

Modifiable on Resume

Yes

Specifies the IP address of the bastion host for bastion-based access to database.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_IP = ip address

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the port number of the bastion host for bastion-based access to database.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_PORT = port_number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the remote host IP address to access from the bastion for bastion-based access to database.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_REMOTEHOSTIP = ip_address

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the user name to access the bastion for bastion-based access to database.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_BASTIONDETAILS_USERNAME = username

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the listener host name or IP address.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS parameters specify connection details for the target OCI database.

These properties are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_HOST = hostname_or_ip

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the listener port number.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_PORT = listener port number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the proxy host name for connecting to the target database through an HTTPS proxy.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_PROXYDETAILS_HOSTNAME = proxy host name

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the HTTP proxy port number for connecting to the source database through an HTTPS proxy.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_PROXYDETAILS_PORT = proxy port number

Default value

There is no default value

Required

No

Modifiable on Resume

Yes

Specifies the fully qualified service name.

This parameter is optional for Autonomous Database targets; however if an HTTP proxy is required to connect, specify it.

In addition, for Oracle Autonomous Database Dedicated Infrastructure and Autonomous Database on Cloud@Customer with fractional OCPU service you must specify the appropriate service alias in the parameter.

You can specify any predefined fractional service alias available; however, for Autonomous Transaction Processing workloads TP* services are preferred over LOW* services because LOW* is meant for low priority batch jobs.

  • TP_TLS, TP, LOW_TLS, or LOW (for Autonomous Transaction Processing workloads)
  • LOW_TLS or LOW (for Autonomous Data Warehouse workloads)

See also Connecting to a DB System and About Connecting to a Dedicated Autonomous Database

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_SERVICENAME = service_name_or_alias

Default value

There is no default value

Valid values

For non-Autonomous, specify the fully qualified service name.

For Autonomous, you can specify the service alias for fractional OCPU service as:

  • TP_TLS, TP, LOW_TLS, or LOW (for Autonomous Transaction Processing workloads)
  • LOW_TLS or LOW (for Autonomous Data Warehouse workloads)

Required

No

Modifiable on Resume

No

Specifies the directory containing client credentials (wallet, keystore, trustfile, etc.) for a TLS connection.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_TLSDETAILS_CREDENTIALSLOCATION = directory

Default value

There is no default value

Required

Not mandatory for migrations

Not required if using TCP

Modifiable on Resume

Yes

Specifies the distinguished name (DN) of the database server (SSL_SERVER_CERT_DN) for a TLS connection.

Parameter Relationships

The TARGETDATABASE_CONNECTIONDETAILS_* parameters specify connection details for the target OCI database.

These are optional for Autonomous Database; however if an HTTP proxy is required to connect, specify them.

Property Description

Syntax

TARGETDATABASE_CONNECTIONDETAILS_TLSDETAILS_DISTINGUISHEDNAME = distinguished_name

Default value

There is no default value

Required

Not mandatory for migrations

Not required if using TCP

Modifiable on Resume

Yes

Specifies the GoldenGate administrator user name for online logical migrations.

Parameter Relationships

The TARGETDATABASE_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_GGADMINUSERNAME = gg_admin_username

Default value

There is no default value

Required

No

Modifiable on Resume

No

Specifies the Oracle Cloud resource identifier.

Parameter Relationships

The TARGETDATABASE_* parameters specify connection details for the target OCI database.

Property Description

Syntax

TARGETDATABASE_OCID = ocid

Default value

There is no default value

Required

Yes

Modifiable on Resume

No

Specifies the Amazon S3 Secret Key wallet path.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_AMAZONS3SECRET = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the OCI Auth Token password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_OCIAUTHTOKEN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the Data Pump encryption password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_DATAPUMPENCRYPTION = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the Oracle GoldenGate hub administrative password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_OGGADMIN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the source database administrative user password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_SOURCECONTAINER = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the source database administrative c##ggadmin user password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_SOURCECGGADMIN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the source database administrative user ggadmin password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_SOURCEGGADMIN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the target database administrative admin password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_TARGETADMIN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.

Specifies the absolute path to the directory that contains the auto login wallet file cwallet.sso, which is used to get the target database administrative user ggadmin password.

The path should be resolvable from the Zero Downtime Migration service host.

About the WALLET_* Parameters

The WALLET_* parameters specify the full path for the auto login wallet file on the Zero Downtime Migration service host.

Property Description

Syntax

WALLET_TARGETGGADMIN = wallet_path

Default value

There is no default value

Required

No

Modifiable on Resume

Until ZDM_PREPARE_DATAPUMP_SRC phase is COMPLETED.


Page 17

ZDMCLI is the command line interface for Zero Downtime Migration migration operations.

To run ZDMCLI commands, go to the /bin directory in the Zero Downtime Migration software home and enter one of the commands listed in the topics below. For example:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database

To list help pages for any ZDMCLI command use the -help option. The following command lists the help for all of the ZDMCLI commands.

zdmuser> $ZDM_HOME/bin/zdmcli -help

To get the current release information for your Zero Downtime Migration software, run ZDMCLI with the -build option.

zdmuser> $ZDM_HOME/bin/zdmcli -build

The following topics describe the Zero Downtime Migration ZDMCLI command usage and options.

You can run options on ZDMCLI without specifying a command.

Syntax

$ZDM_HOME/bin/zdmcli -option

Options

Table G-1 ZDMCLI Options

Option Description
-build Returns Zero Downtime Migration version information, including Cloud Premigration Advisor version.

Terminates the specified job, if running.

Syntax

$ZDM_HOME/bin/zdmcli abort job -jobid job_id

Options

Table G-2 ZDMCLI abort job Options

Option Description
-jobid job_id Unique job ID value (integer) for the scheduled job. The job ID is assigned when the job is scheduled.

Configures a new image type of the specified name and its associated user actions.

Syntax

$ZDM_HOME/bin/zdmcli add imagetype -imagetype image_type -basetype CUSTOM_PLUGIN [-useractions user_action_list]

Options

Table G-3 ZDMCLI add imagetype Options

Option Description
-imagetype image_type

Name of the image type to be created

-basetype CUSTOM_PLUGIN

The base image type for which the image type is created.

Note that CUSTOM_PLUGIN is the only valid value for this mandatory argument.

-useractions user_action_list

Comma-separated list of user action names

Configures a new user action of the specified name with its associated script and action file.

Syntax

$ZDM_HOME/bin/zdmcli add useraction -useraction user_action_name -actionscript script_name [-actionfile file_name] {-pre | -post} -optype MIGRATE_DATABASE [-phase operation_phase] [-onerror {ABORT | CONTINUE}] [-runscope {ONENODE | ALLNODES | AUTO}] [-outputfrom useraction_names]

Options

Table G-4 ZDMCLI add useraction Options

Option Description
-useraction user_action_name

Name of the user action

-actionscript script_name

Script file to be run

-actionfile file_name

File associated with and needed by the user action

-pre

Runs the user action before the operation

-post

Runs the user action after the operation

-optype MIGRATE_DATABASE

Defines the operation for which the user action is configured as MIGRATE_DATABASE.

-phase phase_of_operation

Migration operation phase for which the user action is configured

-onerror {ABORT | CONTINUE}

The response if the user action encounters an error during execution

-runscope {ONENODE | ALLNODES | AUTO}

The servers on which the user action is run.

Specify AUTO to choose the run scope based on the other command options.

-outputfrom useraction_names

Comma-separated list of user action names whose output is to be supplied to the current user action.

Examples

For more examples, see Registering User Actions.

Performs a migration of a database to the Oracle Cloud.

Syntax

$ZDM_HOME/bin/zdmcli migrate database [-sourcedb source_db_unique_name_value | -sourcesid source_oracle_sid} -rsp zdm_template_path -sourcenode source_host_name -targetnode target_host_name [-targethome target_home] [-eval] [-tdekeystorepasswd [-tgttdekeystorepasswd]] [-tdemasterkey] [-useractiondata user_action_data] [-imagetype] [-backupuser user_name [-restoreuser user_name]] [-backuppasswd] [-dvowner database_vault_owner] [-tdewallet wallet_path [-tgttdewallet wallet_path]] [-tdekeystorewallet tde_wallet_path [-tgttdekeystorewallet tde_wallet_path]] [-sourcesyswallet sys_wallet_path] [-osswallet oss_wallet_path [-ossrestorewallet oss_restore_wallet_path]] [-dvwallet dv_wallet_path] [-backupwallet backup_wallet_path] [{-srcroot | -srccred cred_name | -srcuser user_name | {-srcsudouser sudo_user_name -srcsudopath sudo_binary_path} | {-srcauth plugin_name [-srcarg1 user:source_database_server_login_user_name -srcarg2 identity_file:ZDM_installed_user_private_key_file_location -srcarg3 sudo_location:sudo_location]}}] {-tgtroot | -tgtcred cred_name | -tgtuser user_name | {-tgtsudouser sudo_user_name -tgtsudopath sudo_binary_path} | {-tgtauth plugin_name [-tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location -tgtarg3 sudo_location:sudo_location]}} [-schedule {timer_value | NOW}] [-pauseafter phase] [-stopafter phase] [-listphases] [-ignoremissingpatches patch_name [,patch_name...]] [-ignore {ALL | WARNING | PATCH_CHECK | NLS_CHECK | NLS_NCHAR_CHECK | ENDIAN_CHECK}] [-incrementalinterval timer_minutes] [-advisor | -ignoreadvisor | -skipadvisor] [-genfixup {YES | NO}]

Options

Table G-5 ZDMCLI migrate database Options

Option Description
-advisor

Similar to -eval, migrate database will run the minimum phases required for exclusively running Cloud Premigration Advisor Tool (CPAT) on the migration job, without actually running the migration job against the source and target

-ignoreadvisor

Runs Cloud Premigration Advisor Tool (CPAT), but ignores errors generated by CPAT.

-skipadvisor

Skips the CPAT phase of the migration job

-backuppasswd password

In a physical migration, allows you to

1. Create an RMAN backup with provided backup password

2. Use an existing RMAN backup with backup password authentication

-backupuser user_name

Name of the user allowed to back up or restore the database

-restoreuser user_name

Name of the user allowed to restore the database

-backupwallet backup_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the RMAN backup password

-dvwallet dv_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host, containing the credential for the Oracle Database Vault owner

-osswallet oss_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the credential for the Object Storage Service (OSS) backup user

-ossrestorewallet oss_restore_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the credential for the Object Storage Service (OSS) restore backup user

-sourcesyswallet sys_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the SYS password of the source database

-tdewallet wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the Transparent Data Encryption (TDE) keystore password

-tgttdewallet wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing target container database Transparent Data Encryption (TDE) keystore password

If you are converting a non-multitenant source database to a multitenant architecture on the target, that is a pluggable database (PDB), then you can also create an auto-login wallet for the target container database (CDB) TDE keystore password.

-dvowner database_vault_owner

Name of the Oracle Database Vault owner allowed to grant or revoke SYS privileges

-eval

Evaluates the migration job without actually running the migration job against the source and target

-genfixup {YES | NO}

Displays remedial scripts for failing checks when a migration is run with Cloud Premigration Advisor Tool (CPAT) enabled. Any remedies that can be run automatically on the source database are run.

See Cloud Premigration Advisor Tool Support for CPAT use cases supported by Zero Downtime Migration.

-ignore {ALL | WARNING | PATCH_CHECK | NLS_CHECK | NLS_NCHAR_CHECK | ENDIAN_CHECK}

Ignore all checks or specific type of checks:

ALL - ignore all checks

WARNING - ignore checks with warning status

PATCH_CHECK - patch level should be the same

NLS_CHECK - source and target database NLS should be same

NLS_NCHAR_CHECK - source and target database

NLS_NCHAR should be same

ENDIAN_CHECK - source and target database Endian should be same

-ignoremissingpatches

Proceeds with the migration even though the specified patches, which are present in the source path or working copy, might be missing from the destination path or working copy

-imagetype image_type

Name of the user action imagetype

-incrementalinterval timer_minutes

Run periodic incremental RMAN backup every interval (in minutes)

-listphases

Lists the phases for the migration job

-pauseafter phase

Pause the job after running the specified phase

-rsp zdm_template_path

Location of the Zero Downtime Migration response file

-schedule timer_value

Scheduled time to run the migration, in ISO-8601 format.

For example, 2016-12-21T19:13:17+05

-sourcedb source_db_unique_name_value

the DB_UNIQUE_NAME of the source database you want to migrate

-sourcenode source_host_name

Host on which the source database is running

-sourcesid source_oracle_sid

ORACLE_SID of the source single instance database without Grid Infrastructure

-srcauth plug-in_name [plug-in_args]

Use the zdmauth authentication plug-in to access the source database server, and enter the following arguments:

-srcarg1 user:source_database_server_login_user_name -srcarg2 identity_file:ZDM_installed_user_private_key_file_location -srcarg3 sudo_location:sudo_location

If you don't specify the sudo location, the default (/usr/bin/sudo) is used by Zero Downtime Migration.

-srccred cred_name

Credential name with which to associate the user name and password credentials to access the source database server

-srcroot

Directs Zero Downtime Migration to use root credentials to access the source database server

-srcsudopath sudo_binary_path

Location of sudo binary on the source database server

-srcsudouser user_name

Perform super user operations as sudo user name on the source database server

-srcuser user_name

Name of the privileged user performing operations on the source database server

-stopafter phase

Truncates the work flow by the specified phase, and upon completion of the specified phase, the migration job is marked with status completed.

There is no option to resume the job beyond this phase.

For example, if you intend to stop the work flow after Data Guard setup, then specifying -stopafter ZDM_CONFIGURE_DG_SRC stops the job at this phase and the job is marked completed once the ZDM_CONFIGURE_DG_SRC is completed successfully.

-targethome target_home

Location of the target database ORACLE_HOME

-targetnode target_host_name

Target server to which the source database is migrated

-tdekeystorepasswd

Transparent Data Encryption (TDE) keystore password, required for password-based keystore or wallet

-tdekeystorewallet tde_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host containing the Transparent Data Encryption (TDE) keystore password

-tdemasterkey

Transparent Data Encryption (TDE) master encryption key

-tgtauth plugin_name [plugin_args]

Use the zdmauth authentication plug-in to access the target database server, and enter the following arguments:

-tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location -tgtarg3 sudo_location:sudo_location

If you don't specify the sudo location the default (/usr/bin/sudo) is used by Zero Downtime Migration.

-tgtcred cred_name

Credential name with which to associate the user name and password credentials to access the target database server

-tgtroot

Use root credentials to access the target database server

-tgtsudopath sudo_binary_path

Location of the sudo binary on the target database server

-tgtsudouser user_name

Perform super user operations as sudo user name on the target database server

-tgttdekeystorepasswd

Target container database TDE keystore password

-tgttdekeystorewallet tde_wallet_path

Full path for the auto-login wallet file on the Zero Downtime Migration host that contains the target TDE keystore password

-tgtuser user_name

Name of the user performing operations on the target database server

-useractiondata user_action_data

Value to be passed to useractiondata parameter of the user action script

Examples

ZDMCLI migrate database options for an Autonomous Database migration:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -rsp file_path -sourcenode host -srcauth zdmauth -srcarg1 user:username -srcarg2 identity_file:ssh_key_path -srcarg3 sudo_location:sudo_path -eval [-advisor [-ignoreadvisor] | -skipadvisor]]

ZDMCLI migrate database options for a co-managed database migration:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -rsp file_path -sourcenode host -srcauth zdmauth -srcarg1 user:username -srcarg2 identity_file:ssh_key_path -srcarg3 sudo_location:sudo_path -targetnode host -tgtauth zdmauth -tgtarg1 user:username -tgtarg2 identity_file:ssh_key_path -tgtarg3 sudo_location:sudo_path -eval [-advisor [-ignoreadvisor] | -skipadvisor]]

Modifies the list of user actions associated with the specified image type.

Syntax

$ZDM_HOME/bin/zdmcli modify imagetype -imagetype image_type_name -useractions user_action_list

Options

Table G-6 ZDMCLI modify imagetype Options

Option Description
-imagetype image_type

Name of the image type to be modified

-useractions user_action_list

Comma-separated list of user actions that you want to associate with the image type, for example:

-useractions userAction1, userAction2

Allows you to modify the Oracle GoldenGate Extract and Replicat parameters of a running migration job.

Syntax

zdmuser> $ZDM_HOME/bin/zdmcli modify job -jobid job_id -rsp response_file_path

Options

Table G-7 ZDMCLI modify job Options

Option Description
-jobid job_id

Unique job ID value (integer) for the scheduled migration job

The job ID is assigned when the migration job is scheduled.

-rsp response_file_path

Location of the Zero Downtime Migration response file

Modifies the configuration of the user action with the specified name.

Syntax

$ZDM_HOME/bin/zdmcli modify useraction -useraction user_action_name [-actionscript script_name] [-actionfile file_name] [-pre | -post] [-optype MIGRATE_DATABASE] [-phase phase] [-onerror {ABORT | CONTINUE}] [-runscope {ONENODE | ALLNODES | AUTO}] [-outputfrom useraction_names]

Options

Table G-8 ZDMCLI modify useraction Options

Option Description
-useraction user_action_name

Name of the user action

-actionscript script_name

Script file to be run

-actionfile file_name

Accompanying file needed by the user action

-pre

Runs the user action before the operation

-post

Runs the user action after the operation

-optype MIGRATE_DATABASE

Defines the operation for which the user action is configured as MIGRATE_DATABASE

-onerror {ABORT | CONTINUE}

Defines whether to stop or continue running if an error occurs while the user action is running

-runscope {ONENODE | ALLNODES | AUTO}

The servers where the user action will be run.

Specify AUTO to choose the run scope based on the other command options.

-outputfrom useraction_names

Comma-separated list of user action names whose output is to be supplied to the current user action.

Displays the migration job audit records.

Syntax

$ZDM_HOME/bin/zdmcli query audit [[ [-operation { add | abort | modify | migrate | grant | revoke | query | resume | suspend }] [ -entity { client | role | database | user | audit | imagetype | useraction}] | [-user user_name] [-client client_name] | [-from timestamp -to timestamp] | -before timestamp | -since timestamp | -first number | -last number] | -record record_id | -config]

Options

Table G-9 ZDMCLI query audit Options

Option Description
-operation { add | abort | modify | migrate | grant | revoke | query | resume | suspend }

The operation type for which to display audit records

-entity { client | role | database | user | audit | imagetype | useraction }

The entity for which to display audit records

-user user_name

Name of the user who ran the migration operations

-client client_name

Client cluster name where migration operations were executed

-from timestamp

Date for getting a range of audit records, in the format YYYY-MM-DD.

-to timestamp

Date for getting a range of audit records, in the format YYYY-MM-DD

-since timestamp

Date to get audit records since the date provided, in the format YYYY-MM-DD

-before timestamp

Date to get audit records before the date provided, in the format YYYY-MM-DD

-first number

First number of audit records to get from the query

-last number

Last number of audit records to get from the query

-record record_ID

Audit record ID

-config

Show maximum record configuration

Gets the current status of scheduled migration jobs.

Syntax

$ZDM_HOME/bin/zdmcli query job [-jobid job_id [-jobtype]] [-sourcenode source_host_name [-sourcedb db_name | -sourcesid sid]] [-targetnode target_host_name] [-latest] [-eval | -migrate] [-status {SCHEDULED | EXECUTING | UNKNOWN | TERMINATED | FAILED | SUCCEEDED | PAUSED | ABORTED}] [-phase] [-dbname database_name] [-since timer_value] [-upto timer_value] [-brief] [-statusonly]

Options

Table G-10 ZDMCLI query job Options

Option Description
-jobid job_id

Unique job ID value (integer) for the scheduled migration job

The job ID is assigned when the migration job is scheduled.

-job_type

Returns the type of the scheduled job

-sourcenode source_host_name

Server on which the source database is running

-sourcedb db_name

Name of the source database to be migrated

-sourcesid sid

The ORACLE_SID of the source single instance database without Grid Infrastructure

-targetnode target_host_name

Target server to which the database is migrated

-latest

Returns the most recent job that matches the given criteria

-eval

Returns evaluation jobs only

-migrate

Returns migration jobs only

-status {SCHEDULED | EXECUTING | UNKNOWN | TERMINATED | FAILED | SUCCEEDED | PAUSED | ABORTED}

Returns jobs that match the specified job status

-phase

Returns the status of the given phase. If the phase supplied by the user is invalid, the query returns an error.

./zdmcli query job -jobid 33 -phase ZDM_PREUSERACTIONS_TGT -statusonly # exmaple.com: Audit ID: 153 # Job ID: 33 # ZDM_PREUSERACTIONS_TGT:PENDING
-dbname unique_db_name

Specifies the database DB_UNIQUE_NAME value

-since timer_value

Date from which to get the jobs, in ISO-8601 format. For example: 2016-12-21T19:13:17+05

-upto timer_value

Upper limit time to which to get the jobs, in ISO-8601 format. For example: 2016-12-21T19:13:17+05

-brief

Returns job details summary only

-statusonly

Returns only the job status and current phase name

Usage Notes

To identify if the current run is a resumption of a PAUSED migration job, a restart of a FAILED migration job, or a fresh start for a migration job, use the following options:

  • zdmcli query job -latest gets the latest job without considering the job_type
  • zdmcli query job -latest -migrate gets the latest non-evaluation migration job
  • zdmcli query job -latest -eval get the latest evaluation migration job

Displays the configuration of a user action.

Syntax

$ZDM_HOME/bin/zdmcli query useraction [-useraction user_action_name | -imagetype image_type [-optype MIGRATE_DATABASE]]

Options

Table G-11 ZDMCLI query useraction Options

Option Description

-useraction user_action_name

Name of the user action

-imagetype image_type

Specify the image type name

-optype MIGRATE_DATABASE

Operation for which the user action is configured

Resumes a specified job that was paused.

Syntax

$ZDM_HOME/bin/zdmcli resume job -jobid job_id [-pauseafter pause_phase | -rsp zdm_logical_template_path] [-rerun {BACKUP|RESTORE}]

Options

Table G-12 ZDMCLI resume job Options

Option Description
-jobid job_id

Unique job ID value (integer) for the scheduled job

The job ID is assigned when the migration job is scheduled.

-pauseafter pause_phase

Pauses the migration job after running the specified phase

-rerun {BACKUP|RESTORE}

In a physical migration, you can choose to rerun RMAN backup or restore operations on resume.

BACKUP causes Zero Downtime Migration to re-run phases starting from the ZDM_BACKUP_INCREMENTAL_SRC phase. As part of the re-run of the backup phase, an RMAN crosscheck is first run to ensure that the source controlfile is consistent with any backups present on the backup media.

RESTORE triggers rerun of the restore-related phases which includes dropping the existing target database, restoring spfile, restoring controlfile and datafiles.

See the Usage Notes below for more information.

-rsp zdm_logical_template_path

Specify the migration response file if you modified any parameters to be picked up by Zero Downtime Migration on resume.

This option can only be used with logical migration jobs.

Usage Notes

See Resume a Migration Job

The -rerun {BACKUP|RESTORE} option which enables the phase rerun provides you an option to retry backup or restore procedures on failure. You might use this option if

  • Backups are accidentally deleted before the restore is attempted/completed.

  • The TDE wallet is changed after Zero Downtime Migration has already copied the wallet to the target, so the differential backup source would encrypt the backup with the new wallet but the incremental restore will fail because the target will not have the latest wallet. In this case using -rerun will trigger a re-copy of the wallet and subsequently rerun of restore including dropping and recreating the target.

Suspends the specified job if running. Executing suspend job stops the ongoing job at the current work flow phase and allows jobs to be resumed later.

Syntax

$ZDM_HOME/bin/zdmcli suspend job -jobid job_id

Options

Table G-13 ZDMCLI suspend job Options

Option Description
-jobid job_id

Unique job ID value (integer)

The job ID number is assigned when the migration job is scheduled.


Page 18

Previous Next JavaScript must be enabled to correctly display this content

A  B  D  E  H  K  L  M  O  R  S  T  U  Z  

  • abort job command G.2
  • action template 6.5, 6.6
  • add imagetype command G.3

  • DATAPATCH_WITH_ONE_INSTANCE_RUNNING E.3
  • deinstall 8.4

  • encryption requirements B

  • key pair without passphrase 3.7

  • list phases in a migration job 7.5

  • MAX_DATAPATCH_DURATION_MINS E.5
  • migration job
    • list phases 7.5
    • rerun 7.9
    • status 7.4

  • requiremenmts, encryption B
  • rerun a migration job 7.9
  • response file parameters
    • BACKUP_PATH E.1
    • DATAPATCH_WITH_ONE_INSTANCE_RUNNING E.3
    • HOST E.4
    • MAX_DATAPATCH_DURATION_MINS E.5
    • OPC_CONTAINER E.9
    • SHUTDOWN_SRC E.11
    • SKIP_FALLBACK E.12
    • SKIP_SRC_SERVICE_RETENTION E.13
    • SRC_BASTION_HOST_IP E.14
    • SRC_BASTION_IDENTITY_FILE E.15
    • SRC_BASTION_PORT E.16
    • SRC_BASTION_USER E.17
    • SRC_CONFIG_LOCATION E.18
    • SRC_HOST_IP E.20
    • SRC_HTTP_PROXY_PORT E.21
    • SRC_HTTP_PROXY_URL E.22
    • SRC_OSS_PROXY_HOST E.23
    • SRC_OSS_PROXY_PORT E.24
    • SRC_RMAN_CHANNELS E.26
    • SRC_SSH_RETRY_TIMEOUT E.27
    • SRC_TIMEZONE E.28
    • SRC_ZDLRA_WALLET_LOC E.29
    • TGT_BASTION_HOST_IP E.30
    • TGT_BASTION_IDENTITY_FILE E.31
    • TGT_BASTION_PORT E.32
    • TGT_BASTION_USER E.33
    • TGT_CONFIG_LOCATION E.34
    • TGT_DATAACFS E.35
    • TGT_DATADG E.36
    • TGT_DB_UNIQUE_NAME E.37
    • TGT_HOST_IP E.38
    • TGT_HTTP_PROXY_PORT E.39
    • TGT_HTTP_PROXY_URL E.40
    • TGT_OSS_PROXY_HOST E.41
    • TGT_OSS_PROXY_PORT E.42
    • TGT_RECOACFS E.43
    • TGT_RECODG E.44
    • TGT_REDOACFS E.45
    • TGT_REDODG E.46
    • TGT_RMAN_CHANNELS E.48
    • TGT_SKIP_DATAPATCH E.49
    • TGT_SSH_RETRY_TIMEOUT E.50
    • TGT_SSH_TUNNEL_PORT E.51
    • TGT_ZDLRA_WALLET_LOC E.52
    • ZDLRA_CRED_ALIAS E.53
    • ZDM_BACKUP_RETENTION_WINDOW E.57
    • ZDM_CURL_LOCATION E.60
    • ZDM_LOG_OSS_PAR_URL E.61
    • ZDM_OPC_RETRY_COUNT E.62
    • ZDM_OPC_RETRY_WAIT_TIME E.63
    • ZDM_SRC_TNS_ADMIN E.71
    • ZDM_USE_EXISTING_UNDO_SIZE E.76

  • SHUTDOWN_SRC E.11
  • SKIP_FALLBACK E.12
  • SKIP_SRC_SERVICE_RETENTION E.13
  • SRC_BASTION_HOST_IP E.14
  • SRC_BASTION_IDENTITY_FILE E.15
  • SRC_BASTION_PORT E.16
  • SRC_BASTION_USER E.17
  • SRC_CONFIG_LOCATION E.18
  • SRC_HOST_IP E.20
  • SRC_HTTP_PROXY_PORT E.21
  • SRC_HTTP_PROXY_URL E.22
  • SRC_OSS_PROXY_HOST E.23
  • SRC_OSS_PROXY_PORT E.24
  • SRC_RMAN_CHANNELS E.26
  • SRC_SSH_RETRY_TIMEOUT E.27
  • SRC_TIMEZONE E.28
  • SRC_ZDLRA_WALLET_LOC E.29
  • SSH key without passphrase 3.7
  • status of migration job 7.4

  • TGT_BASTION_HOST_IP E.30
  • TGT_BASTION_IDENTITY_FILE E.31
  • TGT_BASTION_PORT E.32
  • TGT_BASTION_USER E.33
  • TGT_CONFIG_LOCATION E.34
  • TGT_DATAACFS E.35
  • TGT_DATADG E.36
  • TGT_DB_UNIQUE_NAME E.37
  • TGT_HOST_IP E.38
  • TGT_HTTP_PROXY_PORT E.39
  • TGT_HTTP_PROXY_URL E.40
  • TGT_OSS_PROXY_HOST E.41
  • TGT_OSS_PROXY_PORT E.42
  • TGT_RECOACFS E.43
  • TGT_RECODG E.44
  • TGT_REDOACFS E.45
  • TGT_REDODG E.46
  • TGT_RMAN_CHANNELS E.48
  • TGT_SKIP_DATAPATCH E.49
  • TGT_SSH_RETRY_TIMEOUT E.50
  • TGT_SSH_TUNNEL_PORT E.51
  • TGT_ZDLRA_WALLET_LOC E.52

  • ZDLRA_CRED_ALIAS E.53
  • ZDM_BACKUP_RETENTION_WINDOW E.57
  • ZDM_CURL_LOCATION E.60
  • ZDM_LOG_OSS_PAR_URL E.61
  • ZDM_OPC_RETRY_COUNT E.62
  • ZDM_OPC_RETRY_WAIT_TIME E.63
  • ZDM_SRC_TNS_ADMIN E.71
  • ZDM_USE_EXISTING_UNDO_SIZE E.76
  • zdmcli
    • abort job G.2
    • add imagetype G.3