19 DBCA Silent Mode Commands

This section lists all the DBCA silent mode commands along with their syntax and parameter description.

addInstance

The addInstance command adds a database instance to an administrator-managed Oracle RAC database.

Syntax and Parameters

Use the dbca -addInstance command with the following syntax:

dbca -addInstance 
   -gdbName global_database_name
   -nodeName database_instance_node_name
   [-updateDirService {true | false}
      -dirServiceUserName directory_service_user_name
      -dirServicePassword directory_service_user_password]
   [-instanceName database_instance_name]
   [-sysDBAUserName SYSDBA_user_name]
   [-sysDBAPassword SYSDBA_user_password]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletPassword wallet_account_password
      -dbCredentialsWalletLocation wallet_files_directory]

Table 19-1 addInstance Parameters

Parameter Required/Optional Description

-gdbName global_database_name

Required

Global database name in the form database_name.domain_name.

-nodeName database_instance_node_name

Required

Node name of the database instance.

-instanceName database_instance_name

Optional

Database instance name.

-sysDBAUserName SYSDBA_user_name

Optional

User name of the database user having the SYSDBA privileges.

-sysDBAPassword SYSDBA_user_password

Optional

Password of the database user having the SYSDBA privileges.

-updateDirService

{true | false}

Optional

Specify true to register the database with a directory service, else specify false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the directory service.

  • —dirServicePassword: Password for the directory service user.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

configureDatabase

The configureDatabase command configures a database.

Syntax and Parameters

Use the dbca -configureDatabase command with the following syntax:

-configureDatabase
        -sourceDB database_unique_name_for_RAC database_or_SID__for_single_instance_database
        [-addDBOption Specify any of the following DB Options as a comma-separated list: JSERVER | ORACLE_TEXT | CWMLITE | SPATIAL | OMS | DV]
        [-configureOML4PY Configure OML4Py in the database]
            [-enableOml4pyEmbeddedExecution Specify true to enable embedded Python execution]
            [-oml4pyConfigTablespace Specify the tablespace to be used for OracleOML4Py configuration]
        [-configureOracleR Configure Oracle R in the database]
            [-oracleRConfigTablespace Specify the tablespace to be used for Oracle R configuration]
        [-configureTDE true | false Specify true to configure TDE wallet]
            [-encryptPDBTablespaces Specify ALL to encrypt all Tablespaces or a comma separated list of name:value pairs with tablespace encryption to true/false]
            [-encryptTablespaces Specify ALL to encrypt all Tablespaces or A comma separated list of name:value pairs with tablespace encryption to true/false]
            [-pdbTDEPassword Specify password for PDB TDE wallet]
            [-primaryDBTdeWallet Specify the location for TDE wallet of primary database]
            [-sourcePdbTDEPassword Specify password for source PDB TDE wallet and it is used only in creation of PDB from existing PDB which has TDE wallet]
            [-sourceTdeWalletPassword Specify password for source database TDE wallet]
            [-tdeAlgorithm Specify the TDE Algorithm Type]
            [-tdeWalletLoginType Specify the TDE Wallet Login Type PASSWORD | AUTO_LOGIN  | LOCAL_AUTO_LOGIN. Default is PASSWORD for SI and AUTO_LOGIN is default for RAC]
            [-tdeWalletModeForPDB Type of keystore either UNITED or ISOLATED. Default is UNITED]
            [-tdeWalletPassword Specify password for TDE wallet]
            [-tdeWalletPathInTarFile value]
            [-tdeWalletRoot Specify the location for TDE wallet root init parameter]
        [-dvConfiguration true | false Specify true to configure and enable database vault]
            -dvUserName Specify database vault owner user name
            -dvUserPassword Specify database vault owner password
            [-dvAccountManagerName Specify separate database vault account manager]
            [-dvAccountManagerPassword Specify database vault account manager password]
        [-exportTDEKeys Export TDE master encryption keys]
            [-tdeKeysFilePath Location to export TDE master encryption keys]
            [-tdeKeysFileSecret Secret to export TDE master encryption keys]
            [-tdeWalletPassword Specify password for TDE wallet]
        [-moveDatabaseFiles Move database files from one storage location to other]
            -datafileDestination Destination directory for all database files
            -sourceDB Database unique name for RAC database or SID for single instance database
            [-initParams Comma separated list of name=value pairs]
                [-initParamsEscapeChar Specify escape character for comma when a specific initParam has multiple values]
            [-recoveryAreaDestination Destination directory for all recovery files]
                [-recoveryAreaSize Fast Recovery Area Size in MB]
            [-recoveryAreaSize Fast Recovery Area Size in MB]
            [-useOMF true | false Specify true to use Oracle-Managed Files]
        [-olsConfiguration true | false Specify true to configure and enable Oracle Label Security]
        [-prepareTrueCacheConfigFile | -configureTrueCacheInstanceService | -cleanupTrueCacheService]
        [-prepareTrueCacheConfigFile Option to prepare config file for creating true cache]
            -sourceDB Database unique name for RAC database or SID for single instance database
            [-tdeWalletPassword Specify password for TDE wallet]
            [-trueCacheBlobLocation Location to create the config file]
        [-configureTrueCacheInstanceService Option to configure true cache service and update database service property]
            -serviceName Database service name to update true cache service property
            -sourceDB Database unique name for RAC database or SID for single instance database
            -trueCacheConnectString EZCONNECT string to connect to true cache
            -trueCacheServiceName True cache service name
            [-pdbName Pluggable database name]
        [-cleanupTrueCacheInstanceService Option to cleanup true cache service and update primary database service property]
            -serviceName Database service name to update true cache service property
            -sourceDB Database unique name for RAC database or SID for single instance database
            -trueCacheConnectString EZCONNECT string to connect to true cache service. For example "host:port/servicename"
            -trueCacheServiceName True cache service name
            [-pdbName Pluggable database name]
        [-registerWithDirService | -unregisterWithDirService | -regenerateDBPassword]
        [-registerWithDirService true | false]
            -dirServiceUserName User name for directory service
            [-databaseCN Database common name]
            [-dirServiceCertificatePath Path to the certificate file to use when configuring SSL between database and directory service]
            [-dirServicePassword Password for directory service]
            [-dirServiceUser SamAccountName in case of configuring Oracle Active Directory]
            [-ldapDirectoryAccessType PASSWORD | SSL]
            [-useSYSAuthForLDAPAccess true | false]
            [-walletPassword Password for database wallet]
        [-unregisterWithDirService true | false]
            -dirServiceUserName User name for directory service
            [-dirServicePassword Password for directory service]
            [-walletPassword password for database wallet]
        [-regenerateDBPassword true | false]
        [-runDatapatch database runDatapatch - patches the database]
            -sourceDB database unique name for RAC database or SID for single instance database
            [-pdbsToRunDatapatch Option to run datapatch only on given PDBs]
            [-skipClosedPDBs flag to skip the datapatch on closed PDBs]
            [-skipPDBs comma-separated list of PDBs to be skipped for current operation]
        [-sysDBAPassword password for sysDBAUserName user name]
        [-sysDBAUserName User name with SYSDBA privileges]
        [-tdeWalletPassword password_for_TDE_wallet]
        [-useWalletForDBCredentials true | false specify true to load database credentials from wallet]
            -dbCredentialsWalletLocation path of the directory containing the wallet files
            [-dbCredentialsWalletPassword password to open wallet with auto login disabled]

Table 19-2 configureDatabase Parameters

Parameter Required/Optional Description

-sourceDB database_sid

Required

The database system identifier (SID) of the database being configured.

-addDBOption

database_options

Optional

Specify one or more of the following Oracle Database options in the form of a comma separated list:

  • JSERVER: Oracle JServer JAVA Virtual Machine

  • ORACLE_TEXT: Oracle Text

  • IMEDIA: Oracle Locator (fully supported) and Oracle Multimedia (desupported)

  • CWMLITE: Oracle OLAP with Oracle Warehouse Builder (OWB)

  • SPATIAL: Oracle Spatial and Graph

  • OMS: Oracle Management Server

  • APEX: Oracle Application Express

  • DV: Oracle Database Vault

Example:

-addDBOption JSERVER,ORACLE_TEXT,OMS
-configureOML4PY

Optional

Specify this parameter to configure Oracle Machine Learning for Python in the database.

Additionally, you specify the following parameters:
  • -oml4pyConfigTablespace to configure the tablespace of OracleOML4Py configuration. The default tablespace is SYSAUX.
  • -enableOml4pyEmbeddedExecution to enable the embedded Python component of Oracle Machine Learning for Python. The default value is TRUE.

-configureOracleR

Optional

Specify this parameter to configure Oracle R in the database.

Additionally, you can specify the -oracleRConfigTablespace parameter to assign a tablespace for the Oracle R configuration, such as SYSAUX tablespace.

-dvConfiguration

{true | false}

Optional

Specify true to enable and configure Database Vault, or specify false. Default is false.

When true is specified, the following additional Database Vault parameters are required:

  • -dvUserName: Specify the Database Vault owner username.

  • -dvUserPassword: Specify Database Vault owner password.

  • -dvAccountManagerName: Specify a separate Database Vault account manager.

  • -dvAccountManagerPassword: Specify the Database Vault account manager password.

-configureTDE{true | false}

Optional

Specify true to configure TDE wallet. Default is false.

When true is specified, the following additional parameters can be provided:

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -pdbTDEPassword: Password for the PDB TDE wallet.

  • -primaryDBTdeWallet: Specify the location for TDE wallet of primary database.

  • -sourcePdbTDEPassword: Specify password for the source PDB TDE wallet. This password is used only in the creation of a PDB from an existing PDB which has TDE wallet.

  • -sourceTdeWalletPassword: Specify password for source database TDE wallet.

  • -tdeAlgorithm: Specify the TDE algorithm type.

  • -tdeWalletLoginType: Specify the TDE wallet login type, PASSWORD | AUTO_LOGIN | LOCAL_AUTO_LOGIN. The default is PASSWORD for single-instance database and AUTO_LOGIN for Oracle RAC database.

  • -tdeWalletModeForPDB: Specify the type of keystore, either UNITED or ISOLATED. Default is UNITED.

  • -tdeWalletPassword: Specify password for TDE wallet.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

  • -tdeWalletRoot: Specify the location for TDE wallet root init parameter.

-exportTDEKeys

Optional

Specify this parameter to export TDE master encryption keys.

Specify the following additional parameters:

  • -tdeKeysFilePath: Location to export TDE master encryption keys

  • -tdeKeysFileSecret: Secret to export TDE master encryption keys

  • -tdeWalletPassword: Specify the password for TDE wallet

-moveDatabaseFiles

Optional

Specify this parameter to move database files from one storage location to another storage location. For example, to move database files from ASM to FS, or from FS to ASM.

Specify the following additional parameters:

  • -datafileDestination: Destination directory for all the database files

  • -sourceDB: Database system identifier (SID) for a single instance database or database unique name for an Oracle RAC database

  • -initParams: Database initialization parameters in the form of comma separated list of name=value pairs

    Additionally, you can specify the -initParamsEscapeChar parameter for using a specific escape character between multiple values of an initialization parameter. If an escape character is not specified, backslash (/) is used as the default escape character.

  • -recoveryAreaDestination: Destination directory for the Fast Recovery Area, which is a backup and recovery area. Specify NONE to disable Fast Recovery Area.

    Additionally, you can specify the Fast Recovery Area size in megabytes using the parameter -recoveryAreaSize. This parameter is optional.

  • -useOMF: Specify true to use Oracle-Managed Files (OMF), else specify false.

-olsConfiguration

{true | false}

Optional

Specify true to enable and configure Oracle Label Security, else specify false. Default is false.

When true is specified, you can additionally specify the -configureWithOID parameter to configure Oracle Label Security with Oracle Internet Directory (OID). This parameter is optional.

-regenerateDBPassword {true | false}

Optional

Specify true to regenerate Oracle Internet Directory (OID) server registration password, else specify false. Default is false.

-registerWithDirService

{true | false}

Optional

Specify true to register with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service.

  • -databaseCN: Database common name.

  • -dirServiceCertificatePath: Directory service certificate file path.

  • -dirServiceUser: Directory service user name.

  • -ldapDirectoryAccessType {PASSWORD | SSL}: LDAP directory access type.

  • -useSYSAuthForLDAPAccess {true | false}: Specify whether to use SYS user authentication for LDAP access.

  • -walletPassword: Password for the database wallet.

-sysDBAPassword SYSDBA_user_password

Optional

Password of a user having SYSDBA privileges.

-sysDBAUserName SYSDBA_user_name

Optional

User name of a user having SYSDBA privileges.

-unregisterWithDirService

{true | false}

Optional

Specify true to unregister with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service.

  • -walletPassword: Password for the database wallet.

-tdeWalletPassword

Optional

Specify password for TDE wallet.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

--prepareTrueCacheConfigFile Required for True Cache

Use this option to prepare a configuration BLOB file that contains the primary database's password file or wallet.

Enter the following additional parameters for this option:

  • -sourceDB: Enter the primary database system identifier (SID) or database unique name (DB_UNIQUE_NAME).
  • -tdeWalletPassword: If the primary database uses a Transparent Data Encryption (TDE) wallet, enter the password for the wallet. This parameter is optional.
  • -trueCacheBlobLocation: Enter the path where you want to save the configuration BLOB file on the primary database. This parameter is optional.
-configureTrueCacheInstanceService Required for True Cache

Use this option to configure the True Cache database application service on the primary database and start the service on True Cache.

Enter the following additional parameters for this option:

  • -serviceName: Enter the primary database application service name.
  • -sourceDB: Enter the primary database SID or database unique name (DB_UNIQUE_NAME).
  • -trueCacheConnectString: Enter the Easy Connect (EZConnect) string to connect to True Cache.

    Example: host:port/service_name

  • -trueCacheServiceName: Enter a name for the True Cache database application service.
  • -pdbName: Enter the primary pluggable database (PDB) name. This parameter is optional.
-cleanupTrueCacheInstanceService Required for True Cache

Use this option to remove the True Cache database application services from the primary database configuration if, for example, you delete True Cache.

Enter the following additional parameters for this option:

  • -serviceName: Enter the primary database application service name.
  • -sourceDB: Enter the primary database SID or database unique name (DB_UNIQUE_NAME).
  • -trueCacheConnectString: Enter the Easy Connect (EZConnect) string to connect to True Cache.

    Example: host:port/service_name

-runDatapatch

Database runDatapatch

Optional

Specify the database on which to apply the data patch.

The following additional parameters are required:

  • -sourceDB: Database unique name for Oracle RAC database or SID for single-instance database for the data patch.

  • -pdbsToRunDatapatch: Option to run datapatch only on given PDBs. For example pdb1,pdb2.

  • -skipClosedPDBs: Flag to skip the data patch on closed PDBs.

  • -skipPDBs: A comma-separated list of PDBs to be skipped for current operation.

configureDataguard

The configureDataguard command configure Oracle Data Guard.

Syntax and Parameters

Use the dbca -configureDataguard command with the following syntax:

dbca -configureDataguard 
    -sourceDB database_unique_name_for_RAC_database_or_SID_for_single_instance_database
    [-enableDGDebug option_to_enable_tracing_for dgmgrl_command]
    [-switchOver switch_over to_standby_db]
    [-targetStandbyDB value]

Table 19-3 configureDataguard Parameters

Parameter Required/Optional Description

-sourceDB database_unique_name

Required

Specifies the source database name.

-enableDGDebug

Optional

Option to enable tracing for dgmrl command.

-switchOver

Optional

Specifies the option to switchover to the standby database.

-targetStandbyDB

Optional

Specifies the target standby database.

configurePluggableDatabase

The configurePluggableDatabase command configures a pluggable database (PDB).

Syntax and Parameters

Use the dbca -configurePluggableDatabase command with the following syntax:

dbca -configurePluggableDatabase
   -pdbName pdb_name 
   -sourceDB cdb_sid
   [-configureOML4PY
      [-oml4pyConfigTablespace tablespace_for_OML4PY_configuration]
      [-enableOml4pyEmbeddedExecution {true | false}]]
   [-configureOracleR
      [-oracleRConfigTablespace tablespace_for_Oracle_R_configuration]]
   [-dvConfiguration {true | false}
      -dvUserName Database_Vault_owner_name
      -dvUserPassword Database_Vault_owner_password
      [-dvAccountManagerName Database_Vault_account_manager_name]
      [-dvAccountManagerPassword Database_Vault_account_manager_password]]
   [-lbacsysPassword LBACSYS_user_password]]
   [-olsConfiguration {true | false}
      [-configureWithOID configure_with_OID_flag]]
   [-pdbTimezone {{+|-}hh:mi|time_zone_region}]
   [-registerWithDirService | -unregisterWithDirService | -regenerateDBPassword]
   [-registerWithDirService {true | false}
      -dirServiceUserName directory_service_user_name
      [-dirServicePassword directory_service_user_password]
      [-walletPassword wallet_password]
      [-databaseCN database_common_name]
      [-dirServiceCertificatePath certificate_file_path]
      [-dirServiceUser active_directory_account_user_name]]
   [-unregisterWithDirService {true | false}
      -dirServiceUserName directory_service_user_name
      [-dirServicePassword directory_service_user_password]
      [-walletPassword wallet_password]]
   [-regenerateDBPassword true | false]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletPassword wallet_account_password
      -dbCredentialsWalletLocation wallet_files_directory]
   [-configurePDBSnapshot]
            [-snapshotIntervalInMins interval_in_minutes_for_automatic_snapshot_creation]
            [-maxPDBSnapshots maximum_number_of_snapshots_to_be_retained_during_automatic_snapshot_creation]
   [-configureTDE true | false]
            [-encryptPDBTablespaces]
            [-encryptTablespaces]
            [-pdbTDEPassword password]
            [-primaryDBTdeWallet location_for_TDE_wallet_of_primary_database]
            [-sourcePdbTDEPassword password]
            [-sourceTdeWalletPassword password]
            [-tdeAlgorithm TDE_algorithm_type]
            [-tdeWalletLoginType TDE_wallet_login_type]
            [-tdeWalletModeForPDB type_of_keystore]
            [-tdeWalletPassword password]
            [-tdeWalletPathInTarFile value]
            [-tdeWalletRoot location_for_TDE_wallet_root_init_parameter]
     [-exportTDEKeys]
            [-tdeKeysFilePath location_to_export_TDE_master_encryption_keys]
            [-tdeKeysFileSecret secret_to_export_TDE_master_encryption_keys]
            [-tdeWalletPassword password_for_TDE_wallet]
    [-pdbInitParams comma_separated_list_of_pdb_specific_init_params]
            [-initParamsEscapeChar]

Table 19-4 configurePluggableDatabase Parameters

Parameter Required/Optional Description

-pdbName pdb_name

Required

Name of the PDB.

-sourceDB cdb_sid

Required

The database system identifier (SID) of the CDB.

-configureOML4PY

Optional

Specify this parameter to configure Oracle Machine Learning for Python in the database.

Additionally, you specify the following parameters:
  • -oml4pyConfigTablespace to configure the tablespace of the PYQSYS schema for Oracle Machine Learning for Python. The default tablespace is SYSAUX.
  • -enableOml4pyEmbeddedExecution to enable the embedded Python component of Oracle Machine Learning for Python. The default value is TRUE.

-configureOracleR

Optional

Specify this parameter to configure Oracle R for the PDB.

Additionally, you can specify the -oracleRConfigTablespace parameter to assign a tablespace for the Oracle R configuration, for example, SYSAUX tablespace.

-dvConfiguration {true | false}

Optional

Specify true to enable and configure Database Vault for the PDB, else specify false. Default is false.

When true is specified, the following additional Database Vault parameters are required:

  • -dvUserName: Specify the Database Vault owner user name.

  • -dvUserPassword: Specify Database Vault owner password.

  • -dvAccountManagerName: Specify a separate Database Vault account manager.

  • -dvAccountManagerPassword: Specify the Database Vault account manager password.

-lbacsysPassword

Optional

Specify the LBACSYS user password, if you want to configure OLS with a directory service.

-pdbInitParams

Optional

-pdbInitParams: Specify PDB specific initialization parameters.Comma-separated list of name=value pairs.

-initParamsEscapeChar: Specify escape character for comma when a specific initialization parameter has multiple values. If the escape character is not specified, then backslash is the default escape character.

-olsConfiguration {true | false}

Optional

Specify true to enable and configure Oracle Label Security (OLS) for the PDB, else specify false. Default is false.

When true is specified, you can additionally specify the -configureWithOID parameter to configure Oracle Label Security (OLS) with Oracle Internet Directory (OID). This parameter is optional.

-pdbTimezone{{+|-}hh:mi|time_zone_region}

Optional

Use this parameter to specify the time zone of the PDB.

You can specify the time zone in two ways:
  • By specifying a displacement from UTC (Coordinated Universal Time—formerly Greenwich Mean Time). The valid range of hh:mi is -12:00 to +14:00.
  • By specifying a time zone region. To see a listing of valid time zone region names, query the TZNAME column of the V$TIMEZONE_NAMES dynamic performance view.

-registerWithDirService{true | false}

Optional

Specify true to register the PDB with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service user.

  • -walletPassword: Password for the database wallet.

  • -databaseCN: Database common name.

  • -dirServiceCertificatePath: Directory service certificate file path.

  • -dirServiceUser: Active Directory account user name.

unregisterWithDirService {true | false}

Optional

Specify true to unregister the PDB with the Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service user.

  • -walletPassword: Password for the database wallet.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-configurePDBSnapshot{true | false}

Optional

Specify true to configure automatic snapshot for a PDB. Default is false.

When true is specified, the following additional parameters can be provided:

  • -snapshotIntervalInMins: Specify interval in minutes for automatic snapshot creation.

  • -maxPDBSnapshots: Specify maximum number of snapshots to be retained during automatic snapshot creation.

-configureTDE{true | false}

Optional

Specify true to configure TDE wallet. Default is false.

When true is specified, the following additional parameters can be provided:

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -pdbTDEPassword: Password for the PDB TDE wallet.

  • -primaryDBTdeWallet: Specify the location for TDE wallet of primary database.

  • -sourcePdbTDEPassword: Specify password for the source PDB TDE wallet. This password is used only in the creation of a PDB from an existing PDB which has TDE wallet.

  • -sourceTdeWalletPassword: Specify password for source database TDE wallet.

  • -tdeAlgorithm: Specify the TDE algorithm type.

  • -tdeWalletLoginType: Specify the TDE wallet login type, PASSWORD | AUTO_LOGIN | LOCAL_AUTO_LOGIN. The default is PASSWORD for single-instance database and AUTO_LOGIN for Oracle RAC database.

  • -tdeWalletModeForPDB: Specify the type of keystore, either UNITED or ISOLATED. Default is UNITED.

  • -tdeWalletPassword: Specify password for TDE wallet.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

  • -tdeWalletRoot: Specify the location for TDE wallet root init parameter.

convertToRAC

The convertToRAC command converts a single-instance database to a one-node Oracle RAC database.

Syntax and Parameters

Use the dbca -convertToRAC command with the following syntax:

dbca -convertToRAC 
   -sourceDB database_unique_name_for_RAC database_or_SID__for_single_instance_database
   [-sysPassword SYS_user_password]

Table 19-5 convertToRAC Parameters

Parameter Required/Optional Description

-sourceDB database_sid

Required

The database system identifier (SID) of the database being configured.

-sysPassword

SYS_user_password

Optional

SYS user password for the database.

createCloneTemplate

The createCloneTemplate command creates a clone (seed) database template from an existing database.

Syntax and Parameters

Use the dbca -createCloneTemplate command with the following syntax:

dbca -createCloneTemplate
   -sourceSID source_database_sid
   -sourceDB source_database_name
   -templateName new_database_template_name
   [-promptForWalletPassword]
   [-backupTDEWalletAsAutoLogin true | false Specify true to backup the tde wallet as AUTO_LOGIN]
   [-rmanParallelism parallelism_integer_value]
   [-maxBackupSetSizeInMB maximum_backup_set_size_in_MB]
   [-dataFileBackup {true | false}]
   [-maintainFileLocations true | false]
   [-datafileJarLocation data_files_backup_directory]
   [-sysDBAUserName SYSDBA_user_name]
   [-sysDBAPassword SYSDBA_user_password]
   [-tdeWalletPassword password]
   [-useWalletForDBCredentials {true | false}
       -dbCredentialsWalletPassword wallet_account_password
       -dbCredentialsWalletLocation wallet_files_directory]
   [-uploadToCloud 
       -opcLibPath OPC_library_path
       -opcConfigFile OPC_configuration_file_name
       [-rmanEncryptionPassword rman_encryption_password ]
   [-compressBackup { true | false } ]
   [-walletPassword database_wallet_password]

Table 19-6 createCloneTemplate Parameters

Parameter Required/Optional Description

-sourceSID source_database_sid

or

-sourceDB source_database_name

Required

Specify either the source database system identifier (SID) or the source database name.

-templateName new_database_template_name

Required

Name of the new database template.

-sysDBAUserName SYSDBA_user_name

Optional

User name of a user having the SYSDBA privileges.

-sysDBAPassword SYSDBA_user_password

Optional

Password of the user having the SYSDBA privileges.

-maxBackupSetSizeInMB maximum_backup_set_size_in_MB

Optional

Maximum backup set size in megabytes.

-rmanParallelism parallelism_integer_value

Optional

Parallelism integer value for RMAN operations.

-datafileJarLocation data_files_backup_directory

Optional

Complete directory path to store data files as a backup in a compressed format.

-backupTDEWalletAsAutoLogin {true | false}

Optional

Specify true to backup the TDE wallet as AUTO_LOGIN, else specify false.

-dataFileBackup {true | false}

Optional

Specify true to take the data files backup, else specify false.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-uploadToCloud

Optional

Creates a clone template and uploads it to Oracle Cloud Infrastructure. The structure and data of the database is stored in the template. DBCA can then use this template to create new databases.

To create a template to Oracle Cloud Infrastructure, you must subscribe to the Oracle Database Backup Cloud Service and install the Oracle Database Cloud Backup Module for OCI. Recovery Manager (RMAN) creates a backup containing the details of the clone template. The backup must be encrypted, so you must provide the RMAN encryption password to encrypt backups.

This option is only supported on Linux.

  • opcLibPath: Directory in which the Oracle Database Cloud Backup Module for OCI is stored. The backup module is a system backup to tape (SBT) library that is used to integrate on-premise databases with Oracle Cloud Infrastructure. The file name is libopc.so on Linux.

  • opcConfigFile: Name, with complete location, of the Oracle Database Cloud Backup Module for OCI configuration file. This file is created when you install the backup module.

  • rmanEncryptionPassword: Password used to encrypt the RMAN backups to Cloud that contian the clone template.

See Administering Oracle Database Backup Cloud Service for information about installing and configuring the backup module.

-compressBackup

Optional

Compresses the backup containing the clone template files.

-walletPassword

Optional

Password of the TDE wallet that contains the keys used to encrypt backups. Specify this parameter if Transparent Data Encryption (TDE) must be used to encrypt backups.

-tdeWalletPassword

Optional

Password of the TDE wallet.

-maintainFileLocations

Optional

Specify whether you want to maintain file locations.

createDatabase

The createDatabase command creates a database.

Syntax and Parameters

Use the dbca -createDatabase command with the following syntax:

dbca -createDatabase
    -gdbName global_database_name 
    -responseFile | (-gdbName,-templateName)
    -responseFile response_file_directory
    -templateName database_template_name
    [-adminManaged | -managementPolicy]
    [-adminManaged admin_managed_database]
    [-managementPolicy [AUTOMATIC|RANK]]
    [-characterSet database_character_set]
    [-configureTDE true | false]
            [-encryptPDBTablespaces]
            [-encryptTablespaces]
            [-pdbTDEPassword password]
            [-primaryDBTdeWallet location_for_TDE_wallet_of_primary_database]
            [-sourcePdbTDEPassword password]
            [-sourceTdeWalletPassword password]
            [-tdeAlgorithm TDE_algorithm_type]
            [-tdeWalletLoginType TDE_wallet_login_type]
            [-tdeWalletModeForPDB type_of_keystore]
            [-tdeWalletPassword password]
            [-tdeWalletPathInTarFile value]
            [-tdeWalletRoot location_for_TDE_wallet_root_init_parameter]
    [-createAsContainerDatabase {true | false}
        [-numberOfPDBs number_of_pdbs]
        [-pdbName pdb_name]
        [-pdbStorageMAXSizeInMB maximum_storage_size_of_the_pdb]
        [-pdbStorageMAXTempSizeInMB maximum_temporary_storage_size_of_the_pdb]
        [-useLocalUndoForPDBs {true | false}]
        [-pdbAdminPassword pdb_administrator_password]
        [-pdbOptions pdb_options]]
    [-skipPdbServiceCreation flag to skip the pluggable database service creation]
    [-createListener new_database_listener]
    [-customScripts list_of_custom_sql_scripts]
    [-databaseConfigType {SINGLE | RAC | RACONENODE}
            [-RACOneNodeServiceName service_name_for_RAC_One_Node_database]]
    [-databaseType {MULTIPURPOSE | DATA_WAREHOUSING | OLTP}]
    [-datafileDestination data_files_directory]
    [-datafileJarLocation data_files_backup_directory]
    [-dbOptions database_options]
    [-dvConfiguration {true | false}
        -dvUserName Database_Vault_owner_name
        -dvUserPassword Database_Vault_owner_password
        [-dvAccountManagerName Database_Vault_account_manager_name
        -dvAccountManagerPassword Database_Vault_account_manager_password]]
    [-emConfiguration {CENTRAL | NONE}
        [-dbsnmpPassword DBSNMP_user_password]
        [-omsHost Oracle_Management_Server_host_name]
        [-omsPort Oracle_Management_Server_port_number]
        [-emUser EM_administrator_user_name]
        [-emPassword EM_administrator_user_password]
    [-enableArchive {true | false} 
        [-archiveLogMode {AUTO | MANUAL}]
        [-archiveLogDest archive_log_files_directory]]
    [-initParams initialization_parameters_list
        [-initParamsEscapeChar initialization_parameters_escape_character]]
    [-listeners listeners_list]
    [-memoryMgmtType {AUTO | AUTO_SGA | CUSTOM_SGA}]
    [-memoryPercentage | -totalMemory]
    [-memoryPercentage percentage_of_total_memory_to_assign_to_oracle_database]
    [-nationalCharacterSet database_national_character_set]
    [-nodelist database_nodes_list]
    [-olsConfiguration {true | false}
    [-oracleHomeUserName Oracle_Home_user_name]
    [-oracleHomeUserPassword Oracle_Home_user_password]
    [-recoveryAreaDestination recovery_files_directory
        [-recoveryAreaSize fast_recovery_area_size]]
    [-redoLogFileSize maximum_redo_log_file_size]
    [-registerWithDirService {true | false} 
        [-dirServiceUserName directory_service_user_name]
        [-dirServicePassword directory_service_password]
        [-databaseCN database_common_name]
        [-dirServiceCertificatePath certificate_file_path]
        [-dirServiceUser directory_service_user_name]
        [-ldapDirectoryAccessType ldap_directory_access_type]
        [-useSYSAuthForLDAPAccess use_sys_user_for_ldap_access_flag]
        [-walletPassword wallet_password]]
    [-runCVUChecks {true | false}]
    [-sid database_system_identifier]
    [-sysPassword SYS_user_password]
    [-systemPassword SYSTEM_user_password]
    [-templateFromCloud 
        -opcLibPath OPC_library_path
        -opcConfigFile OPC_config_file_name
        [-rmanDecryptionPassword rman_decryption_password]]
    [-totalMemory total_memory_to_assign_to_oracle_database_in_MB]
    [-useOMF {true | false}]
    [-useWalletForDBCredentials { true | false}
         -dbCredentialsWalletLocation directory_containing_wallet_files
         [-dbCredentialsWalletPassword password_to_open_wallet]]
    [-variables variables_list]
    [-variablesFile variables_file]
    [-enableForceLogging {true | false}]
    [-enableTwoStagePatches specify this flag to enable two stage patches]
    [-rmanParallelism]
    [-sehaNodeList node_names_separated_by_comma_for_Standard_Edition_High_Availability_database]
        [-sehaServiceName value]
    [-skipDatapatch]
    [-storageType FS | ASM | EXASCALE | PMEMFS]
            -datafileDestination | -pmemMountPointPath
            -datafileDestination destination_directory_for_all_database_files
            -pmemMountPointPath mounted_PMEM_file_store_mount_location
                [-pmemFSName PMEM_file_store_name]
                [-pmemFSSizeDefinition]
            [-asmsnmpPassword ASMSNMP_password_for_ASM_monitoring]
   [-useBigFileForTablespace true | false]

Table 19-7 createDatabase Parameters

Parameter Required/Optional Description

-gdbName

global_database_name

Required

Global database name in the form database_name.domain_name.

-responseFile

response_file_directory

Required

Absolute directory path of the response file.

-templateName

database_template_name

Required

Name of an existing database template in the default location or the complete path to a database template that is not in the default location.

-adminManaged

Optional

Administrator-managed database.

-characterSet

database_character_set

Optional

Character set of the database.

configureTDE

Optional

Specify true to configure TDE during the database creation. Only software wallets are supported. You can create a wallet for the entire CDB or for a PDB.

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -pdbTDEPassword: Password for the PDB TDE wallet.

  • primaryDBTdeWallet: This option is not applicable when creating a database.

  • -sourcePdbTDEPassword: Specify password for the source PDB TDE wallet. This password is used only in the creation of a PDB from an existing PDB which has TDE wallet.

  • sourceTdeWalletPassword: If the template that is being used is from a database that uses encryption, or if you are duplicating a database, specify the password of the wallet in the source database.

  • tdeWalletModeForPDB: Specify UNITED to create a wallet for the entire CDB. Use ISOLATED to create a wallet for a PDB.

  • tdeAlgorithm: Algorithm used to encrypt data. Can be one of the following: 3DES168, AES128, AES192, AES256.

  • tdeWalletLoginType: Type of software wallet. PASSWORD or AUTO_LOGIN or LOCAL_AUTO_LOGIN.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

  • -tdeWalletRoot: Specify the location for TDE wallet root init parameter.

  • tdeWalletPassword: The password used to open the wallet. This parameter is mandatory.

Note: Isolated wallets are supported only in Oracle Cloud or Exadata environments.

-enableTwoStagePatches

Optional

Specify this flag to enable two stage patches.

-skipPdbServiceCreation

Optional

Specify -skipPdbServiceCreation flag to skip the PDB service creation.

-createAsContainerDatabase

{true | false}

Optional

Specify true to create a CDB. Specifying false is not supported starting with Oracle Database Release 20.3.

When true is specified, the following additional parameters are optional:

  • -numberOfPDBs: Number of PDBs to create. The default is 0 (zero).

  • -pdbName: Base name of each PDB. A number is appended to each name if -numberOfPDBs is greater than 1. This parameter must be specified if -numberOfPDBs is greater than 0 (zero).

  • -pdbStorageMAXSizeInMB: Maximum storage size for the PDBs in megabytes.

  • -pdbStorageMAXTempSizeInMB: Maximum temporary storage size for the PDBs in megabytes.

  • -useLocalUndoForPDBs {true | false}: Specify whether local undo should be used for the PDBs.

  • -pdbAdminPassword: PDB administrator password.

  • -pdbOptions: Specify PDB options as comma separated list in name:value format.

    Example: JSERVER:true, DV:false

-createListener

new_database_listener

Optional

Database listener to register the database in the form listener_name:port.

-customScripts

custom_scripts_list

Optional

Specify a comma separated list of SQL scripts that needs to be run after the database creation. The scripts are run in the order they are listed.

-databaseConfigType

{SINGLE | RAC | RACONENODE}

Optional

Specify one of the following database configuration types:

  • SINGLE: Single individual database.

  • RAC: Oracle RAC database.

  • RACONENODE: Oracle RAC One Node database.

    For Oracle RAC One Node database, you can specify the service name using the -RACOneNodeServiceName parameter.

-databaseType

{MULTIPURPOSE | DATA_WAREHOUSING | OLTP}

Optional

Specify MULTIPURPOSE if the database is for both OLTP and data warehouse purposes.

Specify DATA_WAREHOUSING if the primary purpose of the database is a data warehouse.

Specify OLTP if the primary purpose of the database is online transaction processing.

-datafileDestination

data_files_directory

Optional

Complete path to the location of the database data files.

-datafileJarLocation

data_files_backup_directory

Optional

Absolute directory path of the database backup data files stored in a compressed RMAN backup format (files with .dfb extensions).

-dbOptions

database_options

Optional

Specify database options as comma separated list of name:value pairs.

Example: JSERVER:true,DV:false

-dvConfiguration

{true | false}

Optional

Specify true to enable and configure Database Vault, else specify false. Default is false.

When true is specified, the following additional Database Vault parameters are required:

  • -dvUserName: Specify Database Vault owner name.

  • -dvUserPassword: Specify Database Vault owner password.

  • -dvAccountManagerName: Specify Database Vault account manager name.

  • -dvAccountManagerPassword: Specify Database Vault account manager password.

-emConfiguration

{CENTRAL | NONE}

Optional

Enterprise Manager configuration settings.

When CENTRAL is specified, specify the following additional parameters:

  • -dbsnmpPassword: DBSNMP user password.

  • -omsHost: Oracle Management Server host name.

  • -omsPort: Oracle Management Server port number.

  • -emUser: User name for Enterprise Manager administrator.

  • -emPassword: Password for Enterprise Manager administrator.

-enableArchive

{true | false}

Optional

Specify true to enable log file archive, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -archiveLogMode {AUTO | MANUAL}: Specify either the automatic archive mode or the manual archive mode. Default is automatic archive mode.

  • -archiveLogDest: Directory path for storing the archive log files.

-initParams

initialization_parameters_list

Optional

A comma-separated list of name=value pairs of initialization parameter values for the database.

You can additionally provide the -initParamsEscapeChar parameter for using a specific escape character between multiple values of an initialization parameter. If an escape character is not specified, backslash (/) is used as the default escape character.

-listeners

listeners_list

Optional

A comma-separated list of listeners for the database.

-managementPolicy

Optional

Use this parameter to set the database management policy.

Optionally, specify the management policy type:
  • AUTOMATIC
  • RANK

The default policy is -adminManaged.

-memoryMgmtType

{AUTO | AUTO_SGA | CUSTOM_SGA}

Optional

Specify one of the following memory management types:

  • AUTO: Automatic memory management for SGA and PGA.

  • AUTO_SGA: Automatic shared memory management for SGA.

  • CUSTOM_SGA: Manual shared memory management for SGA.

Note: If the total physical memory of a database instance is greater than 4 GB, then you cannot specify the Automatic Memory Management option AUTO during the database installation and creation. Oracle recommends that you specify the Automatic Shared Memory Management option AUTO_SGA in such environments.

-memoryPercentage

percentage_of_total_memory_to_assign_to_oracle_database

or

-totalMemory

total_memory_to_assign_to_oracle_database_in_MB

Optional

Specify either -memoryPercentage or -totalMemory.

  • -memoryPercentage

    The percentage of physical memory that can be used by the database.

  • -totalMemory.

    Total amount of physical memory, in megabytes, that can be used by the database.

-nationalCharacterSet

database_national_character_set

Optional

National character set of the database.

-nodelist

database_nodes_list

Optional

List of database nodes separated by comma.

-olsConfiguration

{true | false}

Optional

Specify true to enable and configure Oracle Label Security (OLS), else specify false. Default is false.

-oracleHomeUserName

Oracle_Home_user_name

-oracleHomeUserPassword

Oracle_Home_user_password

Optional

Oracle Home user name and password.

-recoveryAreaDestination

fast_recovery_area_directory

Optional

Destination directory for the Fast Recovery Area, which is a backup and recovery area. Specify NONE to disable Fast Recovery Area.

Additionally, you can specify the Fast Recovery Area size in megabytes using the parameter -recoveryAreaSize. This parameter is optional.

-redoLogFileSize

maximum_size_of_redo_log_file

Optional

Size of each online redo log in megabytes.

-registerWithDirService

{true | false}

Optional

Specify true to register with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: Username for the LDAP service.

  • -dirServicePassword: Password for the LDAP service.

  • -databaseCN: Database common name.

  • -dirServiceCertificatePath: Directory path to the certificate file to use when configuring SSL between the database and the directory service.

  • -dirServiceUser: Directory service user name.

  • -ldapDirectoryAccessType {PASSWORD | SSL}: LDAP directory access type.

  • -useSYSAuthForLDAPAccess {true | false}: Specify whether to use SYS user authentication for LDAP acces.

  • -walletPassword: Password for the database wallet.

-runCVUChecks

{true | false}

Optional

Specify true to run Cluster Verification Utility checks periodically for Oracle RAC databases, else specify false. Default is false.

-sid

database_system_identifier

Optional

Database system identifier (SID).

The SID uniquely identifies the instance that runs the database. If it is not specified, then it defaults to the database name.

-storageType

{FS | ASM | EXASCALE | PMEMFS}

Optional

Specify the storage type of either FS or ASM.

  • FS: File system storage type.

    When FS is specified, your database files are managed by the file system of your operating system. You can specify the directory path where the database files are to be stored using a database template or the -datafileDestination parameter. Oracle Database can create and manage the actual files.

  • ASM: Oracle Automatic Storage Management (Oracle ASM) storage type.

    When ASM is specified, your database files are placed in Oracle ASM disk groups. Oracle Database automatically manages database file placement and naming.

    When ASM is specified, you can also specify the ASMSNMP password using the -asmsnmpPassword parameter. This parameter is optional.

  • EXASCALE: Oracle Exascale storage type.

  • PMEMFS: PMEMFS storage type.

The following additional parameters can be provided:

  • -datafileDestination: Destination directory for all database files.

  • -pmemMountPointPath: Mounted PMEM file store mount location.

  • -pmemFSName: PMEM file store name.

  • -pmemFSSizeDefinition: PMEM file store size definition. Specify value string such as InitialSize:ExtendSize:MaxSize E.G: -pmemFSSizeDefinition 8GB:16GB:100GB or -pmemFSSizeDefinition 2TB:8TB:UNLIMITED

-sysPassword

SYS_user_password

Optional

SYS user password for the new database.

-systemPassword

SYSTEM_user_password

Optional

SYSTEM user password for the new database.

-templateFromCloud

Optional

Creates a database using the clone template that is stored in Oracle Cloud Infrastructure. This option is supported only for Linux.

  • opcLibPath: Directory in which the Oracle Database Cloud Backup Module for OCI is stored. The backup module is a system backup to tape (SBT) library that is used to integrate an on-premise database with Oracle Cloud Infrastructure.

    You must install the Oracle Database Cloud Backup Module for OCI before running this command.

  • opcConfigFile: Name, with complete location, of the Oracle Database Cloud Backup Module for OCI configuration file. This file is created when you install the backup module.

  • rmanDecryptionPassword: Password that must be used to decrypt the RMAN template file stored in Oracle Cloud Infrastructure. This is the same password that was used when creating an RMAN backup of the template.

See Administering Oracle Database Backup Cloud Service for information about installing and configuring the backup module.

-useOMF

{true | false}

Optional

Specify true to use Oracle-Managed Files (OMF), else specify false. Default is false.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-variables

variables_list

Optional

A comma-separated list of name=value pairs for the variables in the database template.

-variablesFile

variables_file

Optional

Name of the variables file with the complete directory path in the database template.

-enableForceLogging

{true | false}

Optional

Specify true to enable force logging at database level else specify false. Default is false.

-rmanParallelism

Optional

Specify the RMAN parallelism.

-sehaNodeList

Optional

Specify the node names separated by comma for the Standard Edition High Availability database.

Specify a value for the service name sehaServiceName.

-skipDatapatch

Optional

Specify the flag to skip data patch.

-useBigFileForTablespace

{true | false}

Optional

Specify true to enable bigfile property to all database tablespace or a comma-separated list of tablespace name:true|false pairs to enable or disable database tablespace bigfile property. For example: SYSTEM:false,SYSAUX:false,USERS:true.

Else, specify false. Default is false.

createDuplicateDB

The createDuplicateDB command creates a duplicate of an Oracle database.

Prerequisites

The following are the prerequisites for using the createDuplicateDB command:

  • The database to be duplicated is in the archivelog mode.

  • If the database to be duplicated is in a remote server, then there must be connectivity from the system where DBCA is running to the remote server.

Syntax and Parameters

Use the dbca -createDuplicateDB command with the following syntax:

dbca -createDuplicateDB 
    -gdbName global_database_name 
    -remoteDBConnString EZCONNECT string to connect to Source database for example "host:port/servicename"
    -sid database_system_identifier
    [-initParams initialization_parameters
        [-initParamsEscapeChar initialization_parameters_escape_character]]
    [-sysPassword SYS_user_password]
    [-skipPDBs comma_separated_list_of_PDBs_to_be_skipped_for_current_operation]
    [-systemPassword SYSTEM_user_password]
    [-adminManaged admin managed database]
    [-nodelist database_nodes_list]
    [-datafileDestination data_files_directory]
    [-recoveryAreaDestination recovery_files_directory
        [-recoveryAreaSize fast_recovery_area_size]]
    [-rmanParallelism parallelism_value]
    [-rmanSectionSizeInGB value]
    [-databaseConfigType {SINGLE | RAC | RACONENODE}
        [-RACOneNodeServiceName service_name_for_RAC_One_Node_database]]
    [-dgTNSNamesoraFilePath location to create tnsnames.ora for Oracle Data Guard configuration]
    [-standbyBlobFileLocFromPrimaryDB | -passwordFileFromPrimaryDB]
    [-standbyBlobFileLocFromPrimaryDB location of primary database blob file]
    [-passwordFileFromPrimaryDB password file location of primary database]
    [-primaryDBTdeWallet location for TDE wallet of primary database]
    [-standbyScanName | -standbyHostName]
    [-standbyScanName comma-separated list of SCAN names or SCAN IP addresses of standby database for Oracle Data Guard configuration]
    [-standbyHostName comma-separated list of hostnames or IP addresses of standby database host for Oracle Data Guard configuration for single-instance database]
    [-standbyScanPort | -standbyListenerPort]
    [-standbyScanPort SCAN port of standby database for Oracle Data Guard configuration]
    [-standbyListenerPort listener port of standby database for Oracle Data Guard configuration]
    [-sysPassword SYS user password]
    [-systemPassword SYSTEM user password]
    [-useWalletForDBCredentials true | false specify true to load database credentials from wallet]
        -dbCredentialsWalletLocation path of the directory containing the wallet files
        [-dbCredentialsWalletPassword password to open wallet with auto login disabled]
    [-createAsStandby 
        [-dbUniqueName db_unique_name_for_standby_database]]
    [-customScripts custom_sql_scripts_to_run_after_database_creation]
    [-useWalletForDBCredentials {true | false}
        -dbCredentialsWalletPassword wallet_account_password
        -dbCredentialsWalletLocation wallet_files_directory]
    [-configureTDE true | false ]
          [-pdbTDEPassword value]
          [-primaryDBTdeWallet value]
          [-encryptPDBTablespaces value]
          [-encryptTablespaces value]
          [-sourcePdbTDEPassword value]
          [-sourceTdeWalletPassword value]
          [-tdeWalletRoot tde_wallet_root_init_parameter]
          [-pdbTDEPassword pdb_tde_wallet_password]
          [-tdeWalletModeForPDB pdb_keystore_type]
          [-tdeWalletPathInTarFile value]
          [-tdeAlgorithm TDE_algorithm]
          [-tdeWalletLoginType type_of_wallet_login]
          [-sourcePdbTDEPassword source_pdb_TDE_wallet_password]
          [-tdeWalletPassword TDE_wallet_password]

Table 19-8 createDuplicateDB Parameters

Parameter Required/Optional Description

-gdbName global_database_name

Required

Global database name of the duplicate database in the form database_name.domain_name.

-remoteDBConnString easy_db_connection_string

Required

Easy connection string to connect to the database to be duplicated. Easy connection string must be in the following format:

"host[:port][/service_name][:server][/instance_name]"

-sid database_system_identifier

Required

Database system identifier (SID) of the duplicate database.

The SID uniquely identifies the instance that runs the database. If it is not specified, then it defaults to the database name.

-initParams

initialization_parameters_list

Optional

A comma-separated list of name=value pairs of initialization parameter values for the database.

You can additionally provide the -initParamsEscapeChar parameter for using a specific escape character between multiple values of an initialization parameter. If an escape character is not specified, backslash (/) is used as the default escape character.

-sysPassword

SYS_user_password

Optional

SYS user password.

-adminManaged

Optional

Administrator-managed database.

Note: You can specify either policy-managed database or administrator-managed database.

-nodelist

database_nodes_list

Optional

For administrator-managed database, specify database nodes separated by comma.

-dgTNSNamesoraFilePath

data_guard_location

Optional

Specifies the location to create tnsnames.ora for configuration of Oracle Data Guard.

-datafileDestination

data_files_directory

Optional

Complete directory path for database data files.

-recoveryAreaDestination

fast_recovery_area_directory

Optional

Destination directory for the Fast Recovery Area, which is a backup and recovery area. Specify NONE to disable Fast Recovery Area.

Additionally, you can specify the Fast Recovery Area size in megabytes using the parameter -recoveryAreaSize. This parameter is optional.

-databaseConfigType

{SINGLE | RAC | RACONENODE}

Optional

Specify one of the following database configuration types:

  • SINGLE: Single individual database.

  • RAC: Oracle RAC database.

  • RACONENODE: Oracle RAC One Node database.

    For Oracle RAC One Node database, you can specify the service name using the -RACOneNodeServiceName parameter.

-standbyBlobFileLocFromPrimaryDB

Optional

Specify the location of primary database blob file. You must then specify the passwordFileFromPrimaryDB option, for the password file location of primary database.

Specify primaryDBTdeWallet option for the location for TDE wallet of primary database.

-standbyScanName | -standbyHostName

Optional

Specify either of the options. Use the -standbyScanName option to specify a comma-separated list of SCAN names or SCAN IP addresses of standby database for Oracle Data Guard configuration. Use the -standbyHostName option to specify comma-separated list of host names or IP addresses of standby database host for Oracle Data Guard configuration in case of single-instance database.

-standbyScanPort | -standbyListenerPort

Optional

Specify either of the options. Use the -standbyScanPort option to specify SCAN port of standby database for Oracle Data Guard configuration. Use the -standbyHostName option to specify listener port of standby database for Oracle Data Guard configuration.

-createAsStandby

Optional

Specifies that the duplicate database is a standby database for the primary database.

Optionally, use the -dbUniqueName parameter to set the unique database name for the standby database. If the -dbUniqueName parameter is not specified, then the value of the DB_NAME initialization parameter is used.

-customScripts custom_sql_scripts_to_run_after_database_creation

Optional

A comma separated list of SQL scripts that should be run after the duplicate database is created. The scripts are run in the order listed.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

configureTDE

Optional

Specify true to configure TDE during the database creation. Only software wallets are supported. You can create a wallet for the entire CDB or for a PDB.

  • encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example, SYSTEM:true,SYSAUX:false.

  • encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example, SYSTEM:true,SYSAUX:false.

  • pdbTDEPassword: Specify the TDE wallet password.

  • primaryDBTdeWallet: This option is not applicable when creating a database.

  • sourcePdbTdeWalletPassword: If the template that is being used is from a PDB database that uses encryption, specify the password of the wallet in the source PDB database.

  • sourceTdeWalletPassword: If the template that is being used is from a database that uses encryption, specify the password of the wallet in the source database.

  • tdeWalletModeForPDB: Specify UNITED to create a wallet for the entire CDB. Use ISOLATED to create a wallet for a PDB.

  • tdeAlgorithm: Algorithm used to encrypt data. Can be one of the following: 3DES168, AES128, AES192, AES256.

  • tdeWalletLoginType: Type of software wallet. PASSWORD or AUTO_LOGIN or LOCAL_AUTO_LOGIN.

  • tdeWalletPathInTarFile: Location in which the TDE wallet is stored.

  • tdeWalletPassword: The password used to open the wallet. This parameter is mandatory.

  • tdeWalletRoot: The location for the TDE wallet root initialization parameters.

Note: Isolated wallets are supported only in Oracle Cloud or Exadata environments.

-pdbTDEPassword Optional Specify password for PDB TDE wallet.
-sourcePdbTDEPassword Optional Specify password for source PDB TDE wallet. The password is used only in the creation of a PDB from an existing PDB which has a TDE wallet.
-tdeWalletPathInTarFile Optional Specify the TDE wallet path in a tar file.
-rmanParallelism parallelism_value Optional Specify the parallelism value.
-rmanSectionSizeInGB value Optional Specify the RMAN section size.
-skipPDBs Optional Specify a comma-separated list of PDBs to be skipped for the current operation.
-systemPassword Optional Specify the SYSTEM user password.

createPDBSnapshot

The createPDBSnapshot command creates a snapshot from a PDB.

Syntax and Parameters

Use the dbca -createPDBSnapshot command with the following syntax:

dbca -createPDBSnapshot 
   -pdbName pdb_database_name
   -pdbSnapshotName pdb_snapshot_name
   -sourceDB database_unique_name_for_RAC_database_or_SID_for_single_instance_database

Table 19-9 createPDBSnapshot Parameters

Parameter Required/Optional Description

-pdbName pdb_database_name

Required

Specifies the PDB database name.

-pdbSnapshotName pdb_snapshot_name

Required

Specifies the PDB snapshot name.

-sourceDB source_database

Required

Specifies the name of the source database.

createPluggableDatabase

The createPluggableDatabase command creates a pluggable database (PDB) in a multitenant container database (CDB).

Syntax and Parameters

Use the dbca -createPluggableDatabase command with the following syntax:

dbca -createPluggableDatabase 
   -pdbName name_of_the_pdb_to_create
   -sourceDB cdb_sid
   [-configureTDE {true | false} 
          [-primaryDBTdeWallet value]
          [-sourceTdeWalletPassword value]
          [-tdeWalletRoot tde_wallet_root_init_parameter]
          [-pdbTDEPassword pdb_tde_wallet_password]
          [-tdeWalletModeForPDB pdb_keystore_type]
          [-tdeAlgorithm TDE_algorithm]
          [-tdeWalletLoginType type_of_wallet_login]
          [-sourcePdbTDEPassword source_pdb_TDE_wallet_password]
          [-tdeWalletPassword TDE_wallet_password]]
          [-tdeWalletPathInTarFile value]
          [-encryptPDBTablespaces ALL|tablespace_name:{true | false}]
          [-encryptTablespaces ALL|tablespace_name:{true | false}]
         [-createAsClone true | false Create PDB as clone]
         [-createFromRemotePDB Create a pluggable database from Remote PDB clone operation]
            -remoteDBConnString EZCONNECT string to connect to Source database for example "host:port/servicename"
            -remotePDBName Name of the pluggable database to clone/relocate
            [-createAsRefreshablePDB true|false]
                [-refreshInterval  time interval in minutes to perform automatic refresh of the PDB]
                [-refreshMode AUTO|MANUAL refresh mode of the pluggable database]
            [-createNewPDBAdminUser to create a new PDB Administrator user]
            [-dbLinkName Name of the database link that connects to the remote CDB]
            [-dbLinkUserPassword Common user password of a remote CDB, used by database link to connect to remote CDB]
            [-dbLinkUsername Common user of a remote CDB, used by database link to connect to remote CDB]
            [-excludePDBData value]
            [-excludePDBTablespaces value]
            [-pdbAdminPassword PDB Administrator user password, required only while creating new PDB]
            [-pdbAdminUserName PDB Administrator user name, required only while creating new PDB]
            [-pdbStorageMAXSizeInMB value]
            [-pdbStorageMAXTempSizeInMB value]
            [-remoteDBSYSDBAUserName User name with SYSDBA privileges of remote database]
            [-remoteDBSYSDBAUserPassword Password for remoteDBSYSDBAUserName user of remote database]
            [-remotePDBExportedTDEKeyFile value]
            [-remotePDBExportedTDEKeyPassword value]
            [-skipDatapatch Flag to skip the datapatch run]
            [-sysDBAPassword Password for sysDBAUserName user name]
            [-sysDBAUserName User name  with SYSDBA privileges]
            [-updateDBBlockCacheSize option to enable application to set db block cache size initialization parameters in order to support data copy with different block size]
        [-createFromSnapshot | -snapshot]
        [-createFromSnapshot Specify this property to clone pdb from a pdb snapshot]
            -pdbSnapshotName Specify pdb snapshot name
            [-copyDataFiles true|false]
        [-snapshot Specify this property to clone pdb by thin clone]
   [-createPDBFrom {DEFAULT | FILEARCHIVE | RMANBACKUP | USINGXML | PDB}
      [-pdbArchiveFile pdb_archive_file_name_with_directory_path]
      [-PDBBackUpfile pdb_backup_file_name_with_directory_path]
      [-PDBMetadataFile pdb_metadata_file_name_with_directory_path]
      [-pdbAdminUserName pdb_administrator_name]
      [-pdbAdminPassword pdb_administrator_password]
      [-createNewPDBAdminUser {true | false}]
      [-sourceFileNameConvert method_to_locate_pdb_files]
      [-fileNameConvert names_of_pdb_files]
      [-pdbStorageMAXSizeInMB maximum_storage_size_for_the_pdb_in_MB]
      [-sourcePDBServiceConvertList comma_separated list of source pdb services with new service name]
      [-pdbStorageMAXTempSizeInMB maximum_temporary_storage_size_for_the_pdb_in_MB]
      [-workArea directory_to_unzip_PDB_archive_files_for_FILEARCHIVE_option]
      [-copyPDBFiles  {true | false}]
      [-sourcePDB name_of_the_pdb_to_clone]
   [-createPDBInStandby true|false]
   [-useBigFileForTablespace true | false]
   [-createUserTableSpace {true | false)]
   [-customScripts custom_sql_scripts_to_run_after_PDB_creation]
   [-dvConfiguration {true | false}
      -dvUserName Database_Vault_owner_name
      -dvUserPassword Database_Vault_owner_password
      [-dvAccountManagerName Database_Vault_account_manager_name]
      [-dvAccountManagerPassword Database_Vault_account_manager_password]]
   [-enableAutomaticSnapshot option to enable automatic backup in a pdb]
            -snapshotIntervalInMins interval in minutes for automatic snapshot creation
            [-maxPDBSnapshots maximum number of snapshots to be retained during automatic snapshot creation]
   [-lbacsysPassword LBACSYS_user_password]
   [-pdbInitParams Specify pdb specific init params.Comma separated list of name=value pairs]
            [-initParamsEscapeChar Specify escape character for comma when a specific initParam has multiple values]
        [-pdbNodelist value]
    [-pdbReadOnlyServiceName name of the PDB read-only service to be created on Oracle Data Guard configuration]
        [-pdbServiceName name of the PDB service to be created]

   [-pdbDatafileDestination pdb_data_files_directory]
   [-pdbStorageMAXSizeInMB maximum_storage_size_for_the_pdb_in_MB]
   [-pdbStorageMAXTempSizeInMB maximum_temporary_storage_size_for_the_pdb_in_MB]
   [-pdbTimezone {{+|-}hh:mi|time_zone_region}]
   [-pdbUseMultipleBackup number_of_pdb_backups_to_create]
   [-registerWithDirService {true | false} 
      -dirServiceUserName directory_service_user_name
      [-dirServicePassword directory_service_user_password]
      [-databaseCN directory_service_database_common_name]
      [-dirServiceCertificatePath certificate_file_directory_path]
      [-dirServiceUser active_directory_account_user_name]
      [-walletPassword wallet_password]]
      [-skipPdbServiceCreation Flag to skip the Pluggable Database service creation]
   [-useMetaDataFileLocation {true | false}]
   [-pdbTDEKeyTransportSecret value]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletPassword wallet_account_password
      -dbCredentialsWalletLocation wallet_files_directory]

Table 19-10 createPluggableDatabase Parameters

Parameter Required/Optional Description

-pdbName

name_of_the_pdb_to_create

Required

Name of the new PDB to create.

Note: For Oracle RAC databases, the PDB name must be unique in the cluster.

-sourceDB

cdb_sid

Required

The database system identifier (SID) of the CDB.

configureTDE

Optional

Specify true to configure TDE during the database creation. Only software wallets are supported. You can create a wallet for the entire CDB or for a PDB.

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • primaryDBTdeWallet: This option is not applicable when creating a database.

  • sourceTdeWalletPassword: If the template that is being used is from a database that uses encryption, or if you are duplicating a database, specify the password of the wallet in the source database.

  • sourcePdbTdeWalletPassword: If the template that is being used is from a database that uses encryption, or if you are duplicating a PDB, specify the password of the wallet in the source PDB database.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

  • tdeWalletModeForPDB: Specify UNITED to create a wallet for the entire CDB. Use ISOLATED to create a wallet for a PDB.

  • tdeAlgorithm: Algorithm used to encrypt data. Can be one of the following: 3DES168, AES128, AES192, AES256.

  • tdeWalletLoginType: Type of software wallet. PASSWORD or AUTO_LOGIN or LOCAL_AUTO_LOGIN.

  • tdeWalletLocation: Location in which the TDE wallet is stored.

  • tdeWalletPassword: The password used to open the wallet. This parameter is mandatory.

  • -tdeWalletRoot: Specify the location for TDE wallet root init parameter.

Note: Isolated wallets are supported only in Oracle Cloud or Exadata environments.

-createAsClone

{true | false}

Optional

Specify true if the files you plan to use to create the new PDB are the same files that were used to create an existing PDB. Specifying true ensures that Oracle Database generates unique PDB DBID, GUID, and other identifiers expected for the new PDB.

Specify false, the default, if the files you plan to use to create the new PDB are not the same files that were used to create an existing PDB.

-createFromRemotePDB

Optional

Create a PDB by cloning a remote PDB.

Specify the following parameters:

  • -remotePDBName: Name of the remote PDB to clone.

  • -remoteDBConnString: Database connection string of the remote PDB.

  • -createAsRefreshablePDB: Value can be true or false. Specify true to create the pluggable database as a refreshable PDB.

  • -refreshInterval: Specify time interval in minutes to perform automatic refresh of the PDB.

  • -refreshMode: AUTO|MANUAL Specify the refresh mode of the pluggable database.

  • -createNewPDBAdminUser: Specify this argument if a new PDB Administrator user needs to be created after plugging in PDB from Archive or File Set.

  • -createPDBInStandby: Value can be true or false. Specify true to create PDB in standby database.

  • -enableAutomaticSnapshot: Option to enable automatic backup in a PDB.

  • -snapshotIntervalInMins: Specify interval in minutes for automatic snapshot creation.

  • -maxPDBSnapshots: Specify maximum number of snapshots to be retained during automatic snapshot creation.

  • -pdbInitParams: Specify PDB specific initialization parameters.Comma-separated list of name=value pairs.

  • -initParamsEscapeChar: Specify escape character for comma when a specific initialization parameter has multiple values. If the escape character is not specified, then backslash is the default escape character.

  • -pdbNodelist: Specify the PDB nodelist.

  • -skipPdbServiceCreation: Flag to skip the PDB service creation.

  • -pdbReadOnlyServiceName: Specify the name of the PDB read-only service to be created on Oracle Data Guard configuration.

  • -pdbServiceName: Specify the name of the PDB service to be created.

  • -sysDBAUserName: Name of the SYSDBA user.

  • -sysDBAPassword: Password of the SYSDBA user.

  • -dbLinkName: Name of the database that connects to the remote PDB.

  • -dbLinkUsername: Name of the database link user of the remote PDB.

  • -dbLinkUserPassword: Password of the database link user of the remote PDB.

  • -excludePDBData: Specify if you want to exclude PDB data.

  • -excludePDBTablespaces: Specify if you want to exclude PDB tablespace.

  • -pdbAdminPassword: Password of the PDB admin.

  • -pdbAdminUserName: User name of the PDB admin.

  • -remoteDBSYSDBAUserName: User name with SYSDBA privileges of remote database.

  • -remoteDBSYSDBAUserPassword: Password for remote DB SYSDBA user of remote database.

  • -remotePDBExportedTDEKeyFile: TDE key of the remote PDB.

  • -remotePDBExportedTDEKeyPassword: Password for the TDE key of the remote PDB.

  • -skipDatapatch: Flag to skip the data patch run.

  • -sourcePDBServiceConvertList: Specify comma-separated list of source PDB services with new service name. For example, service_1:new_service_1,service_2:new_service_2

  • -updateDBBlockCacheSize: Option to enable application to set db block cache size initialization parameters in order to support data copy with different block size.

Note:

  • The database user of the local CDB must have the CREATE PLUGGABLE DATABASE privileges in the root container.

  • The remote CDB must be in the local undo mode.

  • The remote PDB must be in the archivelog mode.

  • The database user of the remote PDB to which the database link connects to must have the CREATE PLUGGABLE DATABASE and CREATE SESSION privileges.

-createFromSnapshot | -snapshot

Optional

Create a PDB from a snapshot.

Specify the following parameters:

  • -pdbSnapshotName: Name of the PDB snapshot.

  • -copyDataFiles: Value can be true or false. Specify true to skip snapshot copy.

Specify -snapshot option to clone a PDB by thin clone.

-createPDBFrom

{DEFAULT | FILEARCHIVE | RMANBACKUP | USINGXML | PDB}

Optional

Specify DEFAULT to create the PDB from the CDB's seed. When you specify DEFAULT, the following additional parameters are required:

  • -pdbAdminUserName: The user name of the PDB's local administrator.

  • -pdbAdminPassword: The password for the PDB's local administrator.

Specify FILEARCHIVE to create the PDB from an unplugged PDB's files. When you specify FILEARCHIVE, the following additional parameters are required:

  • -pdbArchiveFile: Complete path and name for unplugged PDB's archive file.

    The archive file contains all of the files for the PDB, including its XML metadata file and its data files. Typically, the archive file has a .gz extension.

  • -createNewPDBAdminUser: Specify true to create a new PDB administrator or false to avoid creating a new PDB administrator.

  • -workArea: Specify the directory location where the PDB archive files need to be unzipped.

Specify RMANBACKUP to create the PDB from a Recovery Manager (RMAN) backup. When you specify RMANBACKUP, the following additional parameters are required:

  • -pdbBackUpfile: Complete path and name for the PDB backup file.

  • -pdbMetadataFile: Complete path and name for the PDB's XML metadata file.

Specify USINGXML to create the PDB from an unplugged PDB's XML metadata file. When you specify USINGXML, the following additional parameter is required:

  • -pdbMetadataFile: Complete path and name for the PDB's XML metadata file.

Specify PDB to create a new PDB by cloning an existing PDB. When you specify PDB, the following additional parameter is required:

  • -sourcePDB: Name of an existing PDB to clone.

Specify the following optional parameters, if required:

  • -sourceFileNameConvert: This parameter specifies how to locate PDB files listed in the PDB XML metadata file.

    See SOURCE_FILE_NAME_CONVERT clause of the CREATE PLUGGABLE DATABASE statement described in Oracle Multitenant Administrator's Guide.

  • -fileNameConvert: This parameter specifies the names of the PDB’s files.

    See FILE_NAME_CONVERT clause of the CREATE PLUGGABLE DATABASE statement described in Oracle Multitenant Administrator's Guide.

  • -pdbStorageMAXSizeInMB: Specify the maximum storage size for the PDB in megabytes.

    See information about PDB storage described in Oracle Multitenant Administrator's Guide.

  • -pdbStorageMAXTempSizeInMB: Specify the maximum temporary storage size for the PDB in megabytes.

  • -copyPDBFiles {true | false}: Specify true if the PDB data files need to be copied, else specify false.

-createUserTableSpace

{true | false}

Optional

Specify true if a default user tablespace needs to be created in the new PDB.

-customScripts

lcustom_sql_scripts_to_run_after_PDB_creation

Optional

Specify a list of custom SQL scripts to run after the PDB creation.

-dvConfiguration

{true | false}

Optional

Specify true to enable and configure Database Vault, else specify false. Default is false.

When true is specified, the following additional Database Vault parameters are required:

  • -dvUserName: Specify the Database Vault owner name.

  • -dvUserPassword: Specify Database Vault owner password.

  • -dvAccountManagerName: Specify a separate Database Vault account manager name.

  • -dvAccountManagerPassword: Specify the Database Vault account manager password.

-lbacsysPassword

LBACSYS_user_password

Optional

Specify the LBACSYS user password if you want to configure OLS with a directory service.

-pdbDatafileDestination

pdb_data_files_directory

Optional

Compete directory path to the new PDB data files.

When this parameter is not specified, either Oracle Managed Files or the PDB_FILE_NAME_CONVERT initialization parameter specifies how to generate the names and locations of the files. If you use both Oracle Managed Files and the PDB_FILE_NAME_CONVERT initialization parameter, then Oracle Managed Files takes precedence.

When this parameter is not specified, Oracle Managed Files is not enabled, and the PDB_FILE_NAME_CONVERT initialization parameter is not set, by default a path to a subdirectory with the name of the PDB in the directory for the root's files is used.

-pdbStorageMAXSizeInMB

maximum_storage_size_for_the_pdb_in_MB

Optional

Specify the maximum storage size for the PDB in megabytes.

-pdbStorageMAXTempSizeInMB

maximum_temporary_storage_size_for_the_pdb_in_MB

Optional

Specify the maximum temporary storage size for the PDB in megabytes.

-pdbTimezone{{+|-}hh:mi|time_zone_region}

Optional

Use this parameter to specify the time zone of the PDB.

You can specify the time zone in two ways:
  • By specifying a displacement from UTC (Coordinated Universal Time—formerly Greenwich Mean Time). The valid range of hh:mi is -12:00 to +14:00.
  • By specifying a time zone region. To see a listing of valid time zone region names, query the TZNAME column of the V$TIMEZONE_NAMES dynamic performance view.

-pdbUseMultipleBackup

number_of_pdb_backups_to_create

Optional

Specify the number of PDB backups to create.

-registerWithDirService

{true | false}

Optional

Specify true to register the PDB with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service.

  • -dirServiceUser: User name for the Active Directory account.

  • -dirServiceCertificatePath: Certificate file path of the directory service.

  • -databaseCN: Common name of the directory service database.

  • -walletPassword: Password for the database wallet.

-useMetaDataFileLocation

{true | false}

Optional

Specify true to use the data file path defined in XML metadata file within a PDB archive when extracting data files.

Specify false, the default, to not use the data file path defined in XML metadata file within a PDB archive when extracting data files.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-pdbTDEKeyTransportSecret value

Required

Name of the PDB TDE key transport secret.

createTemplateFromDB

The createTemplateFromDB command creates a database template from an existing database.

Syntax and Parameters

Use the dbca -createTemplateFromDB command with the following syntax:

dbca -createTemplateFromDB 
   -sourceDB source_database_sid
   -templateName new_database_template_name
   -sysDBAUserName SYSDBA_user_name
   -sysDBAPassword SYSDBA_user_password
   [-maintainFileLocations {true | false}]
   [-connectionString easy_connect_string]
   [-useWalletForDBCredentials {true | false}
       -dbCredentialsWalletPassword wallet_account_password
       -dbCredentialsWalletLocation wallet_files_directory]

Table 19-11 createTemplateFromDB Parameters

Parameter Required/Optional Description

-sourceDB source_database_sid

Required

The source database system identifier (SID).

-templateName new_database_template_name

Required

Name of the new database template.

-sysDBAUserName SYSDBA_user_name

Optional

User name of a user that has SYSDBA privileges.

-sysDBAPassword SYSDBA_user_password

Optional

Password of the user that has SYSDBA privileges.

-maintainFileLocations {true | false}

Optional

Specify true to use the file locations of the database in the template.

Specify false, the default, to use different file locations in the template. The file locations are determined by Oracle Flexible Architecture (OFA).

-connectionString easy_connect_string

Optional

Easy connect string for connecting to a remote database in the following format:

"host[:port][/service_name][:server][/instance_name]"

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

createTemplateFromTemplate

The createTemplateFromTemplate command creates a database template from an existing database template.

Syntax and Parameters

Use the dbca -createTemplateFromTemplate command with the following syntax:

dbca -createTemplateFromTemplate 
    -sourcetemplateName existing_template_name 
    -templateName new_template_name 
    [-variables variables_list]
    [-characterSet database_character_set]
    [-nationalCharacterSet database_national_character_set]
    [-recoveryAreaDestination fast_recovery_area_directory]
        -recoveryAreaSize fast_recovery_area_size]
    [-datafileDestination data_files_directory]
    [-useOMF {true | false}]
    [-datafileJarLocation database_backup_files_directory]
    [-memoryPercentage percentage_of_total_memory_to_assign_to_oracle_database]
    [-totalMemory total_memory_to_assign_to_oracle_database]
    [-dbOptions database_options]
    [-variablesFile variables_file]
    [-redoLogFileSize redo_log_file_size]
    [-initParams initialization_parameters_list]
        [-initParamsEscapeChar escape_character_for_initialization_parameters]
    [-storageType {FS | ASM | EXASCALE | PMEMFS} 
        [-asmsnmpPassword ASMSNMP_password]
          -datafileDestination | -pmemMountPointPath
          -datafileDestination data_files_directory
           -pmemMountPointPath mounted PMEM File Store mount location
            [-pmemFSName PMEM File Store Name]
            [-pmemFSSizeDefinition PMEM File Store Size Definition]
    [-useBigFileForTablespace true | false]
    [-enableArchive {true | false} 
         -archiveLogMode {AUTO | MANUAL}
         -archiveLogDest archive_logs_directory
    [-memoryMgmtType {AUTO | AUTO_SGA | CUSTOM_SGA}]
    [-useWalletForDBCredentials {true | false}
         -dbCredentialsWalletPassword wallet_account_password
         -dbCredentialsWalletLocation wallet_files_directory]

Table 19-12 createTemplateFromTemplate Parameters

Parameter Required/Optional Description

-sourceTemplateName

existing_template_name

Required

Name of an existing database template in the default location or the complete path to a database template that is not in the default location.

-templateName

new_template_name

Required

Name for a new database template.

-variables

variables_list

Optional

A comma-separated list of name=value pairs for the variables in the database template.

-characterSet

database_character_set

Optional

Character set of the database.

-nationalCharacterSet

database_national_character_set

Optional

National character set of the database.

-recoveryAreaDestination

fast_recovery_area_directory

Optional

Directory path for the Fast Recovery Area, which is a backup and recovery area.

-datafileDestination

data_files_directory

Optional

Directory path for the data files.

-useOMF

{true | false}

Optional

Specify true to use Oracle-Managed Files (OMF), else specify false.

-datafileJarLocation

database_backup_files_directory

Optional

Location of the database offline backup (for clone database creation only).

The data files for the seed database are stored in compressed RMAN backup format in a file with a .dfb extension.

-memoryPercentage

percentage_of_total_memory_to_assign_to_oracle_database

or

-totalMemory

total_memory_to_assign_to_oracle_database

Optional

Specify either -memoryPercentage or -totalMemory .

  • -memoryPercentage

    The percentage of physical memory that can be used by the database.

  • -totalMemory

    The amount of physical memory in megabytes that can be used by the database.

-dbOptions

database_options

Optional

Specify database options as comma separated list of name:value pairs.

Example: JSERVER:true,DV:false

-variablesFile

variables_file

Optional

File name with complete directory path to the file that contains the variables and their values in the database template.

-redoLogFileSize

redo_log_file_size

Optional

Size of each online redo log file in megabytes.

-initParams

initialization_parameters_list

Optional

A comma-separated list of name=value pairs of the database initialization parameters and their values.

-storageType

{FS | ASM | EXASCALE | PMEMFS}

Optional

Specify FS for file system and ASM for Oracle Automatic Storage Management (Oracle ASM) system.

When FS is specified, your database files are managed by the file system of your operating system. You specify the directory path where the database files are to be stored using the -datafileDestination parameter.

When ASM is specified, your database files are placed in the Oracle ASM disk groups. Oracle Database automatically manages database file placement and naming. You also specify the ASMSNMP password for ASM monitoring using the -asmsnmpPassword parameter.

EXASCALE: Oracle Exascale storage type.

PMEMFS: PMEMFS storage type.

The following additional parameters can be provided:

  • -datafileDestination: Destination directory for all database files.

  • -pmemMountPointPath: Mounted PMEM file store mount location.

  • -pmemFSName: PMEM file store name.

  • -pmemFSSizeDefinition: PMEM file store size definition. Specify value string such as InitialSize:ExtendSize:MaxSize E.G: -pmemFSSizeDefinition 8GB:16GB:100GB or -pmemFSSizeDefinition 2TB:8TB:UNLIMITED

-useBigFileForTablespace

{true | false}

Optional

Specify true to enable bigfile property to all database tablespace or a comma-separated list of tablespace name:true|false pairs to enable or disable database tablespace bigfile property. For example: SYSTEM:false,SYSAUX:false,USERS:true.

Else, specify false. Default is false.

-enableArchive

{true | false}

Optional

Specify true to enable log file archive. Default is false.

When true is specified, the following additional parameters can be provided:

  • -archiveLogMode {AUTO | MANUAL}: Specify either the automatic archive mode (AUTO) or the manual archive mode (MANUAL). Default is automatic archive mode (AUTO).

  • -archiveLogDest: Directory path for storing the archive log files.

-memoryMgmtType

{AUTO | AUTO_SGA | CUSTOM_SGA}

Optional

Specify one of the following memory management types:

  • AUTO: Automatic memory management for SGA and PGA.

  • AUTO_SGA: Automatic shared memory management for SGA.

  • CUSTOM_SGA: Manual shared memory management for SGA.

Note: If the total physical memory of a database instance is greater than 4 GB, then you cannot specify the Automatic Memory Management option AUTO during the database installation and creation. Oracle recommends that you specify the Automatic Shared Memory Management option AUTO_SGA in such environments.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

createTrueCache

The createTrueCache command configures True Cache. Run this command on the True Cache node.

Syntax and Parameters

Use the dbca -createTrueCache command with the following syntax:

dbca -createTrueCache
   -dbUniqueName true_cache_unique_name | -gdbName true_cache_global_name
   -sourceDBConnectionString primary_db_easy_connect_string
   -trueCacheBlobFromSourceDB true_cache_config_blob_path | -passwordFileFromSourceDB password_file_path
      [-tdeWalletFromSourceDB tde_wallet_path]
   [-createListener new_database_listener]
   [-datafileDestination true_cache_control_file_path
   [-initParams initialization_parameters_list
      [-initParamsEscapeChar initialization_parameters_escape_character]]
   [-listeners listener_list]
   [-pgaAggregateTargetInMB pga_memory_size]
   [-sgaTargetInMB sga_memory_size]
   [-sid true_cache_sid]
   [-sourceTdeWalletPassword primary_db_wallet_password]
   [-tdeWalletLoginType {PASSWORD | AUTO_LOGIN | LOCAL_AUTO_LOGIN}]
   [-tdeWalletRoot tde_wallet_root_init_parameter]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletLocation wallet_files_directory
      [-dbCredentialsWalletPassword wallet_account_password]]

Table 19-13 createTrueCache Parameters

Parameter Required/Optional Description

-dbUniqueName

true_cache_unique_name

or

-gdbName

true_cache_global_name

Required Enter either the unique name for this True Cache or the global database name.

-sourceDBConnectionString

primary_db_easy_connect_string

Required

Enter the Easy Connect (EZConnect) string to connect to the primary database.

Example: host:port/service_name

Note: For Oracle RAC primary databases, set the -sourceDBConnectionString parameter to SCAN:port/service_name.

-trueCacheBlobFromSourceDB

true_cache_config_blob_path

or

-passwordFileFromSourceDB

password_file_path

Required

Enter one of the following:

  • The full path and file name for the configuration BLOB file that contains the primary database's password file or wallet. This is the path where the file is located on the True Cache node.
  • The path to the primary database's password file that was copied to the True Cache node.

If you use -passwordFileFromSourceDB, you can also enter the following additional parameter:

-tdeWalletFromSourceDB: Enter the path to the primary database's Transparent Data Encryption (TDE) wallet file that was copied to the True Cache node. You can copy and use the TDE wallet file only if the primary (source) database has TDE enabled. Otherwise, the wallet file isn't required.

-createListener

new_database_listener

Optional Enter a new database listener to be created and to register the database in the form LISTENER_NAME:PORT.

-datafileDestination

true_cache_control_file_path

Optional Enter the path to the location of the True Cache control files.

-initParams

initialization_parameters_list

Optional

Enter a comma-separated list of name=value pairs with additional initialization parameter values for this True Cache.

You can also provide the -initParamsEscapeChar parameter for using a specific escape character between multiple values of an initialization parameter. If an escape character is not specified, backslash (\) is used as the default escape character.

-listeners

listeners_list

Optional Enter a comma-separated list of existing listeners that the database can be configured with.

-pgaAggregateTargetInMB

pga_memory_size

Optional Enter a value in MB for the target aggregate Program Global Area (PGA) memory to make available to all server processes that are attached to this True Cache.

-sgaTargetInMB

sga_memory_size

Optional Enter a value in MB for the System Global Area (SGA) memory size for this True Cache.

-sid

true_cache_sid

Optional Enter the system identifier (SID) for this True Cache.

-sourceTdeWalletPassword

primary_db_wallet_password

Optional If the primary database uses a TDE wallet, enter the password for the wallet.

-tdeWalletLoginType

{PASSWORD | AUTO_LOGIN | LOCAL_AUTO_LOGIN}

Optional

If the primary database uses a TDE wallet, enter one of the following wallet types:

  • PASSWORD: This is the default for single instance databases.
  • AUTO_LOGIN: This is the default for Oracle RAC instances.
  • LOCAL_AUTO_LOGIN

-tdeWalletRoot

tde_wallet_root_init_parameter

Optional If the primary database uses a TDE wallet, enter the path for the TDE wallet root initialization parameter.

-useWalletForDBCredentials

{true | false}

Optional

If the primary database uses Oracle Wallet for database credentials, enter true. The default is false.

If you enter true, also enter the following additional parameters:

  • -dbCredentialsWalletLocation: Enter the path of the directory that contains the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Enter the password for the Oracle Wallet account to open the wallet with auto-login disabled. This parameter is optional.

deleteDatabase

The deleteDatabase command deletes a database.

Syntax and Parameters

Use the dbca -deleteDatabase command with the following syntax:

dbca -deleteDatabase 
   -sourceDB database_name_or_sid
   [-sysDBAUserName SYSDBA_user_name]
   [-sysDBAPassword SYSDBA_user_password]
   [-forceArchiveLogDeletion]
   [-deRegisterEMCloudControl
     [-omsHost Oracle_Management_Server_host_name
      -omsPort Oracle_Management_Server_port_number
      -emUser EM_administrator_user_name
      -emPassword EM_administrator_password]]
   [-unregisterWithDirService {true | false}
      -dirServiceUserName directory_service_user_name
      [-dirServicePassword directory_service_user_password
      [-walletPassword wallet_password]]
   [-sid database_system_identifier]
   [-tdeWalletPassword password_for_TDE_wallet]
   [-useWalletForDBCredentials {true | false}
       -dbCredentialsWalletPassword wallet_account_password
       -dbCredentialsWalletLocation wallet_files_directory]

Table 19-14 deleteDatabase Parameters

Parameter Required/Optional Description

-sourceDB database_name_or_sid

Required

Database unique name for an Oracle RAC database or database system identifier (SID) for a single instance database.

-sysDBAUserName SYSDBA_user_name

Optional

User name of the user having the SYSDBA privileges.

-sysDBAPassword SYSDBA_password

Optional

Password of the user having the SYSDBA privileges.

-tdeWalletPassword

Optional

Specify password for TDE wallet.

-forceArchiveLogDeletion

Optional

Specify this parameter to delete the database archive logs.

-deRegisterEMCloudControl

Optional

Specify this parameter along with the following parameters to unregister the database with Enterprise Manager Cloud Control:

  • -omsHost: Oracle Management Server host name.

  • -omsPort: Oracle Management Server port number.

  • -emUser: User name for Enterprise Manager administrator.

  • -emPassword: Password for Enterprise Manager administrator.

-unregisterWithDirService {true | false}

Optional

Specify this parameter along with the following parameters to unregister the database with the directory service:

  • -dirServiceUserName: User name for the directory service.

  • -dirServicePassword: Password for the directory service user.

  • -walletPassword: Password for the database wallet.

-sid database_system_identifier

Optional

Database system identifier (SID).

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

deleteInstance

The deleteInstance command deletes a database instance from an administror-managed Oracle RAC database.

Syntax and Parameters

Use the dbca -deleteInstance command with the following syntax:

dbca -deleteInstance 
   -gdbName global_database_name
   -instanceName database_instance_name
   [-nodeName database_instance_node_name]
   [-updateDirService {true | false}
      -dirServiceUserName directory_service_user_name
      -dirServicePassword directory_service_user_password]
   [-sysDBAUserName SYSDBA_user_name]
   [-sysDBAPassword SYSDBA_user_password]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletPassword wallet_account_password
      -dbCredentialsWalletLocation wallet_files_directory]

Table 19-15 deleteInstance Parameters

Parameter Required/Optional Description

-gdbName global_database_name

Required

Global database name in the form database_name.domain_name.

-instanceName database_instance_name

Required

Database instance name.

-nodeName node_name_of_database_instance

Optional

Node name of the database instance.

-sysDBAUserName SYSDBA_user_name

Optional

User name of the database user having the SYSDBA privileges.

-sysDBAPassword SYSDBA_user_password

Optional

Password of the database user having the SYSDBA privileges.

-updateDirService

{true | false}

Optional

Specify true to unregister the database with the directory service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the directory service.

  • —dirServicePassword: Password for the directory service user.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

deletePDBSnapshot

The deletePDBSnapshot command deletes a PDB snapshot.

Syntax and Parameters

Use the dbca -deletePDBSnapshot command with the following syntax:

dbca -deletePDBSnapshot 
   -pdbName pdb_database_name
   -pdbSnapshotName pdb_snapshot_name
   -sourceDB database_unique_name_for_RAC_database_or_SID_for_single_instance_database

Table 19-16 deletePDBSnapshot Parameters

Parameter Required/Optional Description

-pdbName pdb_database_name

Required

Specifies the PDB database name.

-pdbSnapshotName pdb_snapshot_name

Required

Specifies the PDB snapshot name.

-sourceDB source_database

Required

Specifies the name of the source database.

deletePluggableDatabase

The deletePluggableDatabase command deletes a PDB.

Syntax and Parameters

Use the dbca -deletePluggableDatabase command with the following syntax:

dbca -deletePluggableDatabase 
   -sourceDB database_unique_name_for_RAC_database_or_SID_for_single_instance_database
   -pdbName pdb_name
   [-sysDBAUserName SYSDBA_user_name]
   [-sysDBAPassword SYSDBA_user_password]
   [-tdeWalletPassword password_for_TDE_wallet]
   [-unregisterWithDirService {true | false} ]
      -dirServiceUserName directory_service_user_name
      [-dirServicePassword directory_service_user_password ]
      [-walletPassword wallet_password]
   [-useWalletForDBCredentials {true | false} ]
       -dbCredentialsWalletPassword wallet_account_password
       [-dbCredentialsWalletLocation wallet_files_directory]

Table 19-17 deletePluggableDatabase Parameters

Parameter Required/Optional Description

-sourceDB cdb_sid

Required

The database system identifier (SID) of the CDB.

-pdbName pdb_name

Required

Name of the PDB to delete.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters must be provided:

  • -dbCredentialsWalletPassword (Optional): Password for the Oracle Wallet account. If you omit this parameter, DBCA prompts for the password.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-tdeWalletPassword

Optional

Specify password for TDE wallet.

-unregisterWithDirService {true | false}

Optional

Specify this parameter along with the following parameters to unregister the database with the directory service:

  • -dirServiceUserName: User name for the directory service.

  • -dirServicePassword: Password for the directory service user.

  • -walletPassword: Password for the database wallet.

deleteTemplate

The deleteTemplate command deletes a database template.

Syntax and Parameters

Use the dbca -deleteTemplate command with the following syntax:

dbca -deleteTemplate 
   -templateName name_of_an_existing_database_template
      [-templateFromCloud 
      -opcLibPath OPC_library_path
      -opcConfigFile OPC_config_file_name
      [-rmanDecryptionPassword rman_decryption_password]]

Table 19-18 deleteTemplate Parameters

Parameter Required/Optional Description

-templateName

name_of_an_existing_database_template

Required

Name of an existing database template to delete. Specify an existing template in default location or the complete template path for database creation or provide a new template name for template creation.

-templateFromCloud

Optional

Indicates that the template is a Cloud template.

  • opcLibPath: Provide the directory containing the odbsrmt.py script for the delete template operation or provide the directory containing libopc.so.

  • opcConfigFile: Specify the OPC configuration file.

  • rmanDecryptionPassword: Password that must be used to decrypt the RMAN template file stored in Oracle Cloud Infrastructure. This is the same password that was used when creating an RMAN backup of the template.

executePrereqs

The executePrereqs command executes the prerequisites checks and reports the results. This command can be used to check the environment before running dbca to create a database.

Syntax and Parameters

Use the dbca -executePrereqs command with the following syntax:

dbca -executePrereqs 
   -databaseConfigType {SINGLE | RAC | RACONENODE}
        [-RACOneNodeServiceName RAC_node_service_name]
   [-nodelist database_nodes_list]

Table 19-19 executePrereqs Parameters

Parameter Required/Optional Description

-databaseConfigType {SINGLE | RAC | RACONENODE}

Required

Specify one of the following database configuration types:

  • SINGLE: Single individual database.

  • RAC: Oracle RAC database.

  • RACONENODE: Oracle RAC One Node database.

    For Oracle RAC One Node database, you can specify the service name using the -RACOneNodeServiceName parameter.

-nodelist

database_nodes_list

Optional

List of database nodes separated by comma.

generateScripts

The generateScripts command generates scripts, which can be used to create a database.

Syntax and Parameters

Use the dbca -generateScripts command with the following syntax:

dbca -generateScripts 
    -templateName database_template_name 
    -gdbName global_database_name 
    [-sid database_system_identifier]
    [-scriptDest sql_scripts_directory]
    [-createAsContainerDatabase {true | false}
        [-numberOfPDBs number_of_pdbs_to_create]
        [-pdbName pdb_name]
        [-pdbStorageMAXSizeInMB maximum_storage_size_of_the_pdb]
        [-pdbStorageMAXTempSizeInMB maximum_temporary_storage_size_of_the_pdb]
        [-useLocalUndoForPDBs {true | false}]
        [-pdbAdminPassword pdb_administrator_password]
        [-pdbOptions pdb_options]
    [-sysPassword SYS_user_password]
    [-systemPassword SYSTEM_user_password]
    [-sehaNodeList node_names_separated_by_comma_for_Standard_Edition_High_Availability_database]
    [-emConfiguration {CENTRAL | NONE}
        [-dbsnmpPassword DBSNMP_user_password]
        [-omsHost EM_Management_Server_host_name]
        [-omsPort EM_Management_Server_port_number]
        [-emUser EM_administrator_name]
        [-emPassword EM_administrator_password]
    [-dvConfiguration {true | false}
        -dvUserName Database_Vault_owner_user_name
        -dvUserPassword Database_Vault_owner_user_password
        [-dvAccountManagerName Database_Vault_account_manager_name
        -dvAccountManagerPassword Database_Vault_account_manager_password]]
    [-olsConfiguration {true | false}
        [-configureWithOID configure_with_OID_flag]]
    [-datafileDestination data_files_directory]
    [-redoLogFileSize maximum_redo_log_file_size_in_MB]
    [-recoveryAreaDestination fast_recovery_area_directory
        [-recoveryAreaSize fast_recovery_area_size]]
    [-datafileJarLocation data_files_backup_directory]
    [-responseFile response_file_directory]
    [-storageType {FS | ASM} 
        [-asmsnmpPassword ASMSNMP_password]
        -datafileDestination data_files_directory]
    [-runCVUChecks {true | false}]
    [-nodelist database_nodes_list]
    [-enableArchive {true | false} 
        [-archiveLogMode {AUTO | MANUAL}]
        [-archiveLogDest archive_log_files_directory]]
    [-memoryMgmtType {AUTO | AUTO_SGA | CUSTOM_SGA}]
    [-createListener new_database_listener_to_register_the_database_with]
    [-useOMF {true | false}]
    [-dbOptions database_options]
    [-customScripts custom_sql_scripts_to_run_after_database_creation]
    [-adminManaged]
    [-databaseConfigType {SINGLE | RAC | RACONENODE}
            [-RACOneNodeServiceName service_name_for_RAC_one_node_database]]
    [-characterSet database_character_set]
    [-nationalCharacterSet database_national_character_set]
    [-registerWithDirService {true | false} 
        [-dirServiceUserName directory_service_user_name]
        [-dirServicePassword directory_service_user_password]
        [-databaseCN database_common_name]
        [-dirServiceCertificatePath certificate_file_path]
        [-dirServiceUser directory_service_user_name]
        [-ldapDirectoryAccessType ldap_directory_access_type]
        [-useSYSAuthForLDAPAccess use_sys_user_for_ldap_access_flag]
        [-walletPassword wallet_password]]
    [-listeners list_of_listeners_to_register_the_database_with]
    [-variablesFile variables_file]
    [-variables variables_list]
    [-initParams initialization_parameters_list
        [-initParamsEscapeChar initialization_parameters_escape_character]]
    [-sampleSchema {true | false}]
    [-memoryPercentage percentage_of_total_memory_to_assign_to_the_database]
    [-totalMemory total_memory_to_assign_to_the_database_in_MB]
    [-databaseType {MULTIPURPOSE | DATA_WAREHOUSING | OLTP}]
    [-useWalletForDBCredentials {true | false}
        -dbCredentialsWalletPassword wallet_account_password
        -dbCredentialsWalletLocation wallet_files_directory]
        [-storageType FS | ASM | EXASCALE | PMEMFS]
            -datafileDestination | -pmemMountPointPath
            -datafileDestination destination_directory_for_all_database_files
            -pmemMountPointPath mounted_PMEM_file_store_mount_location
                [-pmemFSName PMEM_file_store_name]
                [-pmemFSSizeDefinition]
            [-asmsnmpPassword ASMSNMP_password_for_ASM_monitoring]
        [-configureTDE <true | false> ]
          [-encryptPDBTablespaces Specify ALL to encrypt all Tablespaces or a comma separated list of name:value pairs with tablespace encryption to true/false]
          [-encryptTablespaces Specify ALL to encrypt all Tablespaces or A comma separated list of name:value pairs with tablespace encryption to true/false]
          [-primaryDBTdeWallet value]
          [-sourceTdeWalletPassword value]
          [-tdeWalletRoot tde_wallet_root_init_parameter]
          [-pdbTDEPassword pdb_tde_wallet_password]
          [-tdeWalletModeForPDB pdb_keystore_type]
          [-tdeAlgorithm TDE_algorithm]
          [-tdeWalletLoginType type_of_wallet_login]
          [-sourcePdbTDEPassword source_pdb_TDE_wallet_password]
          [-tdeWalletPassword TDE_wallet_password]
          [-tdeWalletPathInTarFile value]

Table 19-20 generateScripts Parameters

Parameter Required/Optional Description

-templateName database_template_name

Required

Name of an existing database template in the default location or the complete path of a template that is not in the default location.

-gdbName global_database_name

Required

Global database name in the form database_name.domain_name.

-sid

database_system_identifier

Optional

Database system identifier (SID).

The SID uniquely identifies the instance that runs the database. If it is not specified, then it defaults to the database name.

-scriptDest scripts_directory

Optional

Complete directory path to store the scripts.

-createAsContainerDatabase

{true | false}

Optional

Specify true to create a CDB. Specifying false is not supported starting with Oracle Database Release 21c.

When true is specified, the following optional parameters can be provided:

  • -numberOfPDBs: Number of PDBs to create. Default is 0 (zero).

  • -pdbName: Name of each PDB. A number is appended to each PDB name if -numberOfPDBs value is greater than 1. This parameter must be specified if -numberOfPDBs value is greater than 0 (zero).

  • -pdbStorageMAXSizeInMB: Maximum storage size for a PDB in megabytes.

  • -pdbStorageMAXTempSizeInMB: Maximum temporary storage size for a PDB in megabytes.

  • -useLocalUndoForPDBs {true | false}: Flag indicating whether local undo should be used for the PDBs.

  • -pdbAdminPassword: PDB administrator password.

  • -pdbOptions: PDB options in the form of comma separated list. Each option must be specified in the name:value format.

    Example: JSERVER:true,DV:false

-sysPassword

SYS_user_password

Optional

SYS user password for the new database.

-systemPassword

SYSTEM_user_password

Optional

SYSTEM user password for the new database.

-emConfiguration

{CENTRAL | NONE}

Optional

Enterprise Manager configuration settings.

When CENTRAL is specified, specify the following additional parameters:

  • -dbsnmpPassword: DBSNMP user password.

  • -omsHost: Oracle Management Server host name.

  • -omsPort: Oracle Management Server port number.

  • -emUser: User name for Enterprise Manager administrator.

  • -emPassword: Password for Enterprise Manager administrator.

-dvConfiguration

{true | false}

Optional

Specify true to enable and configure Database Vault, else specify false. Default is false.

When true is specified, the following additional Database Vault parameters are required:

  • -dvUserName: Database Vault owner name.

  • -dvUserPassword: Database Vault owner password.

  • -dvAccountManagerName: Database Vault account manager name.

  • -dvAccountManagerPassword: Database Vault account manager password.

-olsConfiguration

{true | false}

Optional

Specify true to enable and configure Oracle Label Security (OLS), else specify false. Default is false.

When true is specified, you can additionally specify the -configureWithOID parameter to configure Oracle Label Security (OLS) with Oracle Internet Directory (OID). This parameter is optional.

-datafileDestination

data_files_directory

Optional

Complete path to the location of the database's data files.

-redoLogFileSize

maximum_size_of_online_redo_log

Optional

Size of each online redo log file in megabytes.

-recoveryAreaDestination

fast_recovery_area_directory

Optional

Directory for the Fast Recovery Area, which is a backup and recovery area. Specify NONE to disable the Fast Recovery Area.

Additionally, you can specify the Fast Recovery Area size in megabytes using the parameter -recoveryAreaSize. This parameter is optional.

-datafileJarLocation

data_files_backup_directory

Optional

Directory of the database backup data files in a compressed RMAN backup format (files with .dfb extensions).

-responseFile

response_file_directory

Optional

Directory path of the response file.

-storageType

{FS | ASM}

Optional

Specify the storage type of either FS or ASM.

  • FS: File system storage type.

    When FS is specified, your database files are managed by the file system of your operating system. You can specify the directory path where the database files are to be stored using a database template or the -datafileDestination parameter. Oracle Database can create and manage the actual files.

  • ASM: Oracle Automatic Storage Management (Oracle ASM) storage type.

    When ASM is specified, your database files are placed in Oracle ASM disk groups. Oracle Database automatically manages database file placement and naming.

    When ASM is specified, you can also specify the ASMSNMP password using the -asmsnmpPassword parameter. This parameter is optional.

-runCVUChecks

{true | false}

Optional

Specify true to run Cluster Verification Utility checks periodically for Oracle RAC databases, else specify false. Default is false.

-nodelist

database_nodes_list

Optional

List of database nodes separated by comma.

-enableArchive

{true | false}

Optional

Specify true to enable log file archive, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -archiveLogMode {AUTO | MANUAL}: Specify either the automatic archive mode or the manual archive mode. Default is automatic archive mode.

  • -archiveLogDest: Directory for storing the archive log files.

-memoryMgmtType

{AUTO | AUTO_SGA | CUSTOM_SGA}

Optional

Specify one of the following memory management types:

  • AUTO: Automatic memory management for SGA and PGA.

  • AUTO_SGA: Automatic shared memory management for SGA.

  • CUSTOM_SGA: Manual shared memory management for SGA.

Note: If the total physical memory of a database instance is greater than 4 GB, then you cannot specify the Automatic Memory Management option AUTO during the database installation and creation. Oracle recommends that you specify the Automatic Shared Memory Management option AUTO_SGA in such environments.

-createListener

new_database_listener

Optional

Database listener to register the database with in the form listener_name:port.

-useOMF

{true | false}

Optional

Specify true to use Oracle-Managed Files (OMF), else specify false.

-dbOptions

database_options

Optional

Specify database options as a comma separated list of name:value pairs.

Example: JSERVER:true,DV:false

-customScripts

custom_sql_scripts_list

Optional

Specify a comma separated list of SQL scripts that need to be run after the database creation. The scripts are run in the order they are listed.

-adminManaged

Optional

Administrator-managed database.

-databaseConfigType

{SINGLE | RAC | RACONENODE}

Optional

Specify one of the following database configuration types:

  • SINGLE: Single individual database.

  • RAC: Oracle RAC database.

  • RACONENODE: Oracle RAC One Node database.

    For Oracle RAC One Node database, you can specify the service name using the -RACOneNodeServiceName parameter.

-characterSet

database_character_set

Optional

Character set of the database.

-nationalCharacterSet

database_national_character_set

Optional

National character set of the database.

-registerWithDirService

{true | false}

Optional

Specify true to register with a Lightweight Directory Access Protocol (LDAP) service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service.

  • -databaseCN: Database common name.

  • -dirServiceCertificatePath: Directory service certificate file path.

  • -dirServiceUser: Directory service user name.

  • -ldapDirectoryAccessType {PASSWORD | SSL}: LDAP directory access type.

  • -useSYSAuthForLDAPAccess {true | false}: Specify whether to use SYS user authentication for LDAP acces.

  • -walletPassword: Password for the database wallet.

-listeners

listeners_list

Optional

A comma-separated list of listeners for the database.

-variablesFile

variables_file

Optional

Directory path to the file that contains the variables and their values for the database template.

-variables

variables_list

Optional

A comma-separated list of name=value pairs of variables for the database template.

-initParams

initialization_parameters_list

Optional

A comma-separated list of name=value pairs of initialization parameter values of the database.

You can additionally provide the -initParamsEscapeChar parameter for using a specific escape character between multiple values of an initialization parameter. If an escape character is not specified, backslash (/) is used as the default escape character.

-sampleSchema

{true | false}

Optional

Specify true to include the HR sample schema (EXAMPLE tablespace) in your database, else specify false. Default is false.

Oracle guides and educational materials contain examples based on the sample schemas. Oracle strongly recommends that you do not install the sample schemas in a production database.

-memoryPercentage

percentage_of_total_memory_assigned_to_the_database

Optional

The percentage of physical memory that can be used by the database.

-totalMemory

total_memory_assigned_to_the_database_in_MB

Optional

Total amount of physical memory, in megabytes, that can be used by the database.

-databaseType

{MULTIPURPOSE | DATA_WAREHOUSING | OLTP}

Optional

Specify MULTIPURPOSE if the database is for both OLTP and data warehouse purposes.

Specify DATA_WAREHOUSING if the primary purpose of the database is a data warehouse.

Specify OLTP if the primary purpose of the database is online transaction processing.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

configureTDE

Optional

Specify true to configure TDE during the database creation. Only software wallets are supported. You can create a wallet for the entire CDB or for a PDB.

  • primaryDBTdeWallet: This option is not applicable when creating a database.

  • sourceTdeWalletPassword: If the template that is being used is from a database that uses encryption, or if you are duplicating a database, specify the password of the wallet in the source database.

  • tdeWalletModeForPDB: Specify UNITED to create a wallet for the entire CDB. Use ISOLATED to create a wallet for a PDB.

  • tdeAlgorithm: Algorithm used to encrypt data. Can be one of the following: 3DES168, AES128, AES192, AES256.

  • tdeWalletLoginType: Type of software wallet. PASSWORD or AUTO_LOGIN or LOCAL_AUTO_LOGIN.

  • tdeWalletLocation: Location in which the TDE wallet is stored.

  • tdeWalletPassword: The password used to open the wallet. This parameter is mandatory.

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

Note: Isolated wallets are supported only in Oracle Cloud or Exadata environments.

-sehaNodeList

Optional

Specify the node names separated by comma for the Standard Edition High Availability database.

Specify a value for the service name sehaServiceName.

-storageType

{FS | ASM | EXASCALE | PMEMFS}

Optional

Specify the storage type of either FS or ASM.

  • FS: File system storage type.

    When FS is specified, your database files are managed by the file system of your operating system. You can specify the directory path where the database files are to be stored using a database template or the -datafileDestination parameter. Oracle Database can create and manage the actual files.

  • ASM: Oracle Automatic Storage Management (Oracle ASM) storage type.

    When ASM is specified, your database files are placed in Oracle ASM disk groups. Oracle Database automatically manages database file placement and naming.

    When ASM is specified, you can also specify the ASMSNMP password using the -asmsnmpPassword parameter. This parameter is optional.

  • EXASCALE: Oracle Exascale storage type.

  • PMEMFS: PMEMFS storage type.

The following additional parameters can be provided:

  • -datafileDestination: Destination directory for all database files.

  • -pmemMountPointPath: Mounted PMEM file store mount location.

  • -pmemFSName: PMEM file store name.

  • -pmemFSSizeDefinition: PMEM file store size definition. Specify value string such as InitialSize:ExtendSize:MaxSize E.G: -pmemFSSizeDefinition 8GB:16GB:100GB or -pmemFSSizeDefinition 2TB:8TB:UNLIMITED

moveDatabase

The moveDatabase command moves a database from one source Oracle home to the target Oracle home.

Syntax and Parameters

Use the dbca -moveDatabase command with the following syntax:

dbca -moveDatabase 
   -sourceDB Database unique name for Oracle RAC database or SID for single-instance database    
   [-continueWithDBDowntime Flag to indicate the move operation with database downtime when there is only one active instance running]    
   [-directoryPathsToCopy A comma-separated list of absolute directory paths that are to be copied from source Oracle home to target Oracle home]    
   [-drainTimeoutInSeconds Specify time in seconds to complete the resource draining while stopping the database]    
   [-filePathsToCopy A comma-separated list of absolute file paths that are to be copied  from source Oracle home to target Oracle home]    
   [-listenersToMove A comma-separated list of listeners that are to be moved]    
   [-nodeListForMove A comma-separated list of nodes if operation has to be performed on subset of nodes]    
   [-nonRolling Flag to indicate the database move would be performed by shutting down the database]    
   [-oracleHomeUserPassword Oracle home user password]    
   [-postMoveScripts A comma-separated list of scripts to be run post move database. The scripts are run in the order they are listed]        
     [-postRollbackScripts A comma-separated list of scripts to be run post move database rollback. The scripts are run in the order they are listed]    
   [-resume Resume the previous operation]        
     [-sessionID Session id of the failed session]    
   [-revert Revert the previous operation]
     [-sessionID Session id of the previous session]            
   [-skipClosedPDBs Flag to skip the datapatch on closed PDBs]    
   [-skipDatapatch Flag to skip the datapatch run]    
   [-skipPDBs A comma-separated list of PDBs to be skipped for current operation. ]    
   [-sqlnetConfigPreference SOURCE | TARGET Specify the sqlnet.ora file move preference.]    
   [-sysDBAPassword Password for sysDBAUserName user name]    
   [-sysDBAUserName User name with SYSDBA privileges]
   [-continueWithDBDowntime Flag to indicate the move operation with database downtime when there is only one active instance running]
   [-doNotEnableTwoStagePatches specify this flag to not enable two stage patches]
   [-errorOnMissingPatches Specify this flag to stop the move operation in case of missing patches in target Oracle home]
       [-exceptionPatchList Specify the list of patch IDs to be ignored when checking missing patches in target Oracle home]
   [-skipMissingPatchValidation Specify this flag to proceed with move operation in case of missing patches in target Oracle home]

Table 19-21 moveDatabase Parameters

Parameter Required/Optional Description

-sourceDB database_sid

Required

Database unique name for Oracle RAC database or SID for single-instance database.

-continueWithDBDowntime

Optional

Specifies the flag to indicate the move operation with database downtime when there is only one active instance running.

-directoryPathsToCopy

Optional

Specify the comma-separated list of absolute directory paths that are to be copied from source Oracle home to target Oracle home.

-drainTimeoutInSeconds

Optional

Specify time in seconds to complete the resource draining while stopping the database.

-filePathsToCopy

Optional

Specify the A comma-separated list of absolute file paths that are to be copied from source Oracle home to target Oracle home.

-listenersToMove

Optional

Specify the comma-separated list of listeners that are to be moved.

-nodeListForMove

Optional

Specify the comma-separated list of nodes if operation has to be performed on subset of nodes.

-nonRolling

Optional

Specify the flag to indicate the database move would be performed by shutting down the database.

-oracleHomeUserPassword

Optional

Specify the Oracle home user password.

-postMoveScripts SYSDBA_user_password

Optional

Specify the comma-separated list of scripts to be run post move database. The scripts are run in the order they are listed.

Use the -postRollbackScripts SYSDBA_user_name option to specify the comma-separated list of scripts to be run post move database rollback. The scripts are run in the order they are listed.

-resume

Optional

Resume the previous operation.

-sessionID

Optional

Specify the session ID of the failed session.

-revert

Optional

Revert the previous operation.

-skipClosedPDBs

Optional

Specify the flag to skip the datapatch on closed PDBs.

-skipDatapatch

Optional

Specify the flag to skip the datapatch run.

-continueWithDBDowntime

Optional

Specify the flag to indicate the move operation with database downtime when there is only one active instance running.

-doNotEnableTwoStagePatches

Optional

Specify this flag to not enable two stage patches.

-errorOnMissingPatches

Optional

Specify this flag to stop the move operation in case of missing patches in target Oracle home.

Use the -exceptionPatchList option to specify the list of patch IDs to be ignored when checking missing patches in target Oracle home.

-skipMissingPatchValidation

Optional

Specify this flag to proceed with move operation in case of missing patches in target Oracle home.

-skipPDBs

Optional

Specify the comma-separated list of PDBs to be skipped for current operation.

-sqlnetConfigPreference {SOURCE | TARGET}

Optional

Specify the sqlnet.ora file move preference.

-sysDBAPassword

Optional

Specify the password for sysDBAUserName user name.

-sysDBAUserName

Optional

Specify the user name with SYSDBA privileges.

relocatePDB

The relocatePDB command relocates a PDB from a remote CDB to a local CDB.

Prerequisites

The following are the prerequisites for running the relocatePDB command:

  • The database user in the local PDB must have the CREATE PLUGGABLE DATABASE privilege in the local CDB root container.

  • The remote CDB must be in the local undo mode.

  • The remote and local PDBs must be in the archivelog mode.

  • The database user in the remote PDB that the database link connects to must have the CREATE PLUGGABLE DATABASE, SESSION, and SYSOPER privileges.

  • The local and remote PDBs must have the same options installed, or the remote PDB must have a subset of the options installed on the local PDB.

Syntax and Parameters

Use the dbca -relocatePDB command with the following syntax:

dbca -relocatePDB 
   -pdbName name_of_the_local_pdb_to_create
   -sourceDB database_name_of_the_local_pdb
   -remotePDBName name_of_the_remote_pdb_to_relocate
   -remoteDBConnString db_connection_string_of_the_remote_pdb
   [-configureTDE true | false Specify true to configure TDE wallet]
            [-encryptPDBTablespaces Specify ALL to encrypt all Tablespaces]
            [-encryptTablespaces Specify ALL to encrypt all Tablespaces]
            [-pdbTDEPassword Specify password for PDB TDE wallet]
            [-primaryDBTdeWallet Specify the location for TDE wallet of primary database]
            [-sourcePdbTDEPassword Specify password for source PDB TDE wallet and it is used only in creation of PDB from existing PDB which has TDE wallet]
            [-sourceTdeWalletPassword Specify password for source database TDE wallet]
            [-tdeAlgorithm Specify the TDE Algorithm Type]
            [-tdeWalletLoginType Specify the TDE Wallet Login Type, PASSWORD | AUTO_LOGIN  | LOCAL_AUTO_LOGIN Default is PASSWORD for SI and AUTO_LOGIN is default for RAC]
            [-tdeWalletModeForPDB Type of keystore, either UNITED or ISOLATED Default is UNITED]
            [-tdeWalletPassword Specify password for TDE wallet]
            [-tdeWalletPathInTarFile value]
            [-tdeWalletRoot Specify the location for TDE wallet root init parameter]
        [-createNewPDBAdminUser Specify this argument if a new PDB Administrator user needs to be created after plugging in PDB from Archive or File Set]
        [-dbLinkName Name of the database link that connects to the remote CDB]
        [-dbLinkUserPassword Common user password of a remote CDB, used by database link to connect to remote CDB]
        [-dbLinkUsername Common user of a remote CDB, used by database link to connect to remote CDB]
        [-pdbAdminPassword PDB Administrator user Password, required only while creating new PDB]
        [-pdbAdminUserName PDB Administrator user name, required only while creating new PDB]
        [-pdbInitParams Specify pdb specific init paramsComma separated list of name=value pairs]
            [-initParamsEscapeChar Specify escape character for comma when a specific initParam has multiple valuesIf the escape character is not specified backslash is the default escape character]
        [-pdbNodelist value]
        [-pdbReadOnlyServiceName Specify the name of the PDB read-only service to be created on dataguard configuration]
        [-pdbServiceName Specify the name of the PDB service to be created]
        [-pdbStorageMAXSizeInMB value]
        [-pdbStorageMAXTempSizeInMB value]
        [-remoteDBSYSDBAUserName User name with SYSDBA privileges of remote database]
        [-remoteDBSYSDBAUserPassword Password for remoteDBSYSDBAUserName user of remote database]
        [-skipDatapatch Flag to skip the datapatch run]
        [-skipPdbServiceCreation Flag to skip the Pluggable Database service creation]
        [-sourcePDBReadOnlyServices Comma-separated source PDB read only services]
        [-sourcePDBServices Comma-separated source PDB services]
        [-sysDBAPassword Password for sysDBAUserName user name]
        [-sysDBAUserName User name with SYSDBA privileges]
        [-updateDBBlockCacheSize option to enable application to set db block cache size initialization parameters in order to support data copy with different block size]
        [-useWalletForDBCredentials true | false Specify true to load database credentials from wallet]
            -dbCredentialsWalletLocation Path of the directory containing the wallet files
            [-dbCredentialsWalletPassword Password to open wallet with auto login disabled]

Table 19-22 relocatePDB Parameters

Parameter Required/Optional Description

-pdbName name_of_the_local_pdb_to_create

Required

Name of the local PDB to create after relocating the remote PDB.

-sourceDB database_name_of_the_local_pdb

Required

Database name of the local PDB.

-remotePDBName name_of_the_remote_pdb_to_relocate

Required

Name of the remote PDB to relocate.

-remoteDBConnString db_connection_string_of_the_remote_pdb

Required

Database connection string of the remote PDB.

-sysDBAUserName name_of_the_sysdba_user

Optional

Name of the SYSDBA user.

-sysDBAPassword password_of_the_sysdba_user

Optional

Password of the SYSDBA user.

-dbLinkUsername name_of_the_dblink_user_of_the_remote_pdb

Optional

Name of the database link user of the remote PDB.

-dbLinkUserPassword password_of_the_dblink_user_of_the_remote_pdb

Optional

Password of the database link user of the remote PDB.

-configureTDE{true | false}

Optional

Specify true to configure TDE wallet. Default is false.

When true is specified, the following additional parameters can be provided:

  • -encryptPDBTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -encryptTablespaces: Specify ALL to encrypt all tablespaces or a comma-separated list of name:value pairs with tablespace encryption to true or false. For example: SYSTEM:true,SYSAUX:false.

  • -pdbTDEPassword: Password for the PDB TDE wallet.

  • -primaryDBTdeWallet: Specify the location for TDE wallet of primary database.

  • -sourcePdbTDEPassword: Specify password for the source PDB TDE wallet. This password is used only in the creation of a PDB from an existing PDB which has TDE wallet.

  • -sourceTdeWalletPassword: Specify password for source database TDE wallet.

  • -tdeAlgorithm: Specify the TDE algorithm type.

  • -tdeWalletLoginType: Specify the TDE wallet login type, PASSWORD | AUTO_LOGIN | LOCAL_AUTO_LOGIN. The default is PASSWORD for single-instance database and AUTO_LOGIN for Oracle RAC database.

  • -tdeWalletModeForPDB: Specify the type of keystore, either UNITED or ISOLATED. Default is UNITED.

  • -tdeWalletPassword: Specify password for TDE wallet.

  • -tdeWalletPathInTarFile: Specify the TDE wallet path in the tar file.

  • -tdeWalletRoot: Specify the location for TDE wallet root init parameter.

-createNewPDBAdminUser

Optional

Specify this argument if a new PDB Administrator user needs to be created after plugging in PDB from Archive or File Set.

-dbLinkName

Optional

Name of the database that connects to the remote PDB.

-pdbAdminPassword

Optional

Specify PDB Administrator user password, required only while creating new PDB.

-pdbAdminUserName

Optional

Specify PDB Administrator user name, required only while creating new PDB.

-pdbInitParams

Optional

Specify PDB specific initialization parameters as comma-separated list of name=value pairs.

-initParamsEscapeChar: Specify escape character for comma when a specific initialization parameter has multiple values. If the escape character is not specified, then backslash is the default escape character.

-pdbNodelist

Optional

Specify PDB node list.

-pdbReadOnlyServiceName

Optional

Specify the name of the PDB read-only service to be created on Oracle Data Guard configuration.

-pdbServiceName

Optional

Specify the name of the PDB service.

-pdbStorageMAXSizeInMB

Optional

Specify the maximum storage size for the PDB in megabytes.

-pdbStorageMAXTempSizeInMB

Optional

Specify the maximum temporary storage size for the PDB in megabytes.

-remoteDBSYSDBAUserName

Optional

Specify the user name with SYSDBA privileges of remote database.

-remoteDBSYSDBAUserPassword

Optional

Specify the password for remote DB SYSDBA user of remote database.

-skipDatapatch

Optional

Flag to skip the data patch run.

-skipPdbServiceCreation

Optional

Flag to skip the PDB service creation.

-sourcePDBReadOnlyServices

Optional

Comma-separated source PDB read-only services.

-sourcePDBServices

Optional

Comma-separated source PDB services.

-updateDBBlockCacheSize

Optional

Option to enable application to set db block cache size initialization parameters in order to support data copy with different block size.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

unplugDatabase

The unplugDatabase command unplugs a pluggable database (PDB) from a multitenant container database (CDB).

Syntax and Parameters

Use the dbca -unplugDatabase command with the following syntax:

dbca -unplugDatabase 
   -sourceDB cdb_sid
   -pdbName pdb_name
   [-maxBackupSetSizeInMB maximum_backup_set_size_in_MB]
   [-unregisterWithDirService {true | false}
      -dirServiceUserName directory_service_user_name
      -dirServicePassword directory_service_user_password
      -walletPassword wallet_password]
   [-archiveType {TAR | RMAN | NONE}
      [-rmanParallelism parallelism_integer_value]
      [-pdbArchiveFile pdb_archive_file_directory]
      [-PDBBackUpfile pdb_backup_file_directory]
      [-PDBMetadataFile pdb_metadata_file_directory]
      [-rmanParallelism parallelism_integer_value]]
   [-useWalletForDBCredentials {true | false}
      -dbCredentialsWalletPassword wallet_account_password
      -dbCredentialsWalletLocation wallet_files_directory]
   [-pdbTDEKeyTransportSecret value]
   [-tdeWalletPassword password for TDE wallet]

Table 19-23 unplugDatabase Parameters

Parameter Required/Optional Description

-sourceDB cdb_sid

Required

The database system identifier (SID) of the CDB.

-pdbName pdb_name

Required

Name of the PDB.

-maxBackupSetSizeInMB

Optional

Specifies the maximum backup set size in MB.

-archiveType {TAR | RMAN | NONE}

Optional

Specify TAR to store the unplugged PDB files in a tar file.

Specify RMAN to store the unplugged PDB files in an RMAN backup.

Specify NONE to store the unplugged PDB files without using a tar file or an RMAN backup.

Specify any of the following parameters:

  • -pdbArchiveFile: Specify absolute file path and name for the PDB Archive file.

  • -pdbBackUpfile: Specify absolute file path and name for the PDB backup file when archive type is RMAN. specify comma separated file paths, if there are multiple backups to be taken when creating the PDB.

  • -pdbMetadataFile: Specify absolute file path and name for the PDB metadata file when archive type is RMAN or NONE.

  • -rmanParallelism: Specify the RMAN parallelism integer value.

-unregisterWithDirService {true | false}

Optional

Specify true to unregister the PDB from the LDAP service, else specify false. Default is false.

When true is specified, the following additional parameters are required:

  • -dirServiceUserName: User name for the LDAP service.

  • -dirServicePassword: Password for the LDAP service user.

  • -walletPassword: Password for the database wallet.

-useWalletForDBCredentials

{true | false}

Optional

Specify true to use Oracle Wallet for database credentials, else specify false. Default is false.

When true is specified, the following additional parameters can be provided:

  • -dbCredentialsWalletPassword: Password for the Oracle Wallet account.

  • -dbCredentialsWalletLocation: Directory location for the Oracle Wallet files.

Note:

If you are using Oracle Unified Directory (OUD), then the OUD passwords should be stored in the wallet using the following keys:

  • oracle.dbsecurity.walletPassword

  • oracle.dbsecurity.userDNPassword

-pdbTDEKeyTransportSecret value

Required

Name of the PDB TDE key transport secret.

-tdeWalletPassword value

Required

Specify the TDE wallet password.