D Zero Downtime Migration Physical Migration Response File Parameters Reference

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

BACKUP_PATH

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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).

ZDM_BACKUP_FULL_SRC_MONITORING_INTERVAL

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).

ZDM_BACKUP_INCREMENTAL_SRC_MONITORING_INTERVAL

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).

ZDM_BACKUP_RETENTION_WINDOW

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

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

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).

ZDM_CURL_LOCATION

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

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

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

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

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).

ZDM_OSS_RESTORE_TGT_MONITORING_INTERVAL

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).

ZDM_RMAN_COMPRESSION_ALGORITHM

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

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

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

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

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

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.

ZDM_USE_EXISTING_BACKUP

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

ZDM_USE_EXISTING_UNDO_SIZE

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.