Quick Start
This article covers the steps required to deploy the pdbctl utility as a command line utility and as a migration server.
Prerequisites
64-bit machine with JDK 1.8.0_252 or higher version.
CDP is installed.
Key Manager should be accessible.
The pdbctl utility should be able to connect with the database where CDP clients are installed. However, for fast processing, it is recommended to deploy the pdbctl utility on the same machine.
To use the pdbctl utility:
Download the drivers compatible with your database versions from their official sites.
Add the .jar files to the
/pdbctl/classes/directory. The following table captures the details of database drivers and their versions that have explicitly been tested.Database Driver Version Oracle ojdbc8.jar 1.8 IBM Db2 db2jcc4.jar 10.1 Microsoft SQL Server mssql-jdbc-6.2.2.jre8 6.2.2.jre8
Tip
It is recommended to use local encryption for faster data migration. To configure local encryption, refer to Local Encryption Configuration Parameters.
Deploy the pdbctl Utility
To deploy pdbctl as utility:
Extract the pdbctl and unzip the pdbctl_v1.x.x.zip file.
Note
The screenshots provided here are from a Linux machine.
For Java 9 and higher versions, download and add the following jar files in the
classesfolder of the pdbctl utility:activation-1.1.1.jarjaxb-api-2.3.1.jarjaxb-core-2.3.0.1.jarjaxb-impl-2.3.1.jar
Set the parameters in the
CADP_for_JAVA.propertiesfile for the pdbctl utility. The file’s location is/pdbctl/classes/CADP_for_JAVA.properties. These parameters are described in the configuration section.Note
Set the Key Manager IP (NAE_IP) and port (NAE_Port) similar to ones set for the CDP clients.
To explicitly set
PDB_MUTIL_PATH, use the following commands. Otherwise, the current directory path will be treated asPDB_MUTIL_PATH.export PDB_MUTIL_PATH=<location of pdbctl>set PDB_MUTIL_PATH=<location of pdbctl>
To deploy pdbctl as server:
Extract and Unzip the pdbctl_v1.x.x.zip file.
Note
The screenshots provided here are from a Linux machine.
For Java 9 and higher versions, download and add the following jar files in the
classesfolder of the pdbctl utility:activation-1.1.1.jarjaxb-api-2.3.1.jarjaxb-core-2.3.0.1.jarjaxb-impl-2.3.1.jar
Set the parameters in the
CADP_for_JAVA.propertiesfile for the pdbctl utility. The file’s location is/pdbctl/classes/CADP_for_JAVA.properties. These parameters are described in the Configuration section.Note
Set the Key Manager IP (NAE_IP) and port (NAE_Port) similar to ones set for the CDP clients.
To explicitly set
PDB_MUTIL_PATH, use the following commands. Otherwise, the current directory path will be treated asPDB_MUTIL_PATH.export PDB_MUTIL_PATH=<location of pdbctl>set PDB_MUTIL_PATH=<location of pdbctl>
Run the pdbctl Utility
To run pdbctl as utility:
Navigate to the directory where the pdbctl utility is extracted.
Run the utility.
On Linux machines, run the following command:
./pdbctlIt displays the available commands for the pdbctl utility. To know more about the commands, use the following syntax:
./pdbctl <command> -h
On Windows machines, run the following command:
pdbctl.exeIt displays the available commands for the pdbctl utility. To know more about the commands, use the following syntax:
pdbctl.exe <command> -h
To run pdbctl as server:
Navigate to the directory where the pdbctl utility is extracted.
Run the utility.
On Linux machines, run the following command:
./pdbctl serve -p <port_number> -c <server_certificate> -k <certificate_key> --verboseTo view the details of
servecommand, refer to Use the pdbctl Utility as Migration Server.On Windows machines, run the following command:
pdbctl.exe serve -p <port_number> -c <server_certificate> -k <certificate_key> --verboseTo view the details of
servecommand, refer to Use the pdbctl Utility as Migration Server.
