Adding an instance of the CDC Replication Engine for Db2 for z/OS Remote Source (UNIX and Linux®)

You must add an instance of the CDC Replication Engine for Db2® for z/OS® Remote Source before you can start replication.

Before you begin

Ensure that you have met all of the prerequisites in Required Db2 and z/OS settings.

About this task

The following steps are for the command-line version of the configuration tool. If an X Window System is available, the configuration tool runs in a graphical environment instead. For the procedure in a graphical environment after the configuration tool has been launched, see Adding an instance of the CDC Replication Engine for Db2 for z/OS Remote Source (Windows).

Note: The CDC Replication Engine for Db2 for z/OS Remote Source offers four configuration options for adding an instance.

Procedure

  1. If you are configuring the first instance of CDC Replication as launched at the end of an installation, you can proceed to Step 3.
  2. At the command prompt, launch the configuration tool by issuing the following command in the specified directory:
    /CDC_installation_directory/bin/dmconfigurets
  3. Follow one of these steps depending on whether this is the first instance that you have added:
    • If this is the first instance, you are presented with a welcome message. After this step you will be taken to Step 4. Press Enter to continue.
    • If at least one instance already exists, you will be presented with a main menu. Enter 2 for your selection and press Enter to add a new instance of the CDC Replication Engine for Db2 for z/OS Remote Source.
  4. Enter the name of the instance that you want to add and press Enter.
    The instance name must be unique.
  5. Enter the port number that CDC Replication uses for communication with client workstations that run Management Console and other servers. The CDC Replication Engine for Db2 for z/OS Remote Source displays a default port of 11801. Press Enter.

    This port number cannot be used by other applications that are installed on the same server. You will use this port number when specifying access parameters for your datastore in the Access Manager perspective in Management Console.

  6. Enter the maximum amount of disk space to be used by the CDC Replication staging store on your source system and press Enter. The default value is 100 GB.
  7. Enter the amount of physically available RAM that you want to allocate for this instance of CDC Replication and press Enter. By default, the configuration tool allocates 1024 MB of RAM for each instance.

    You should only use values other than the defaults or allocate more RAM than is physically available on your server after considering the effects on product performance.

  8. Select the encryption profile from the list.
    If you would like to enable TLS for communication between source and target, you must select an encryption profile with encryption enabled. Click Manage to view and manage the available encryption profiles. Encryption profiles can be shared between multiple instances of CDC Replication.
  9. Enter the host name or IP address of the system on which the database is running. In a data-sharing environment, any active member can be used. Press Enter.
  10. Enter the name of the database on that host. This is the Db2 for z/OS LOCATION name as noted in Required Db2 and z/OS settings. Press Enter.
  11. Enter the TCP/IP port for connecting to the specified database. Press Enter.
  12. Enter y if you wish to configure advanced parameters. Typically the default of n is sufficient. Press Enter.
  13. Enter extra JDBC parameters if desired. Multiple options are separated by semi-colons.
    • You can accept the default of NONE for unencrypted JDBC connections.
    • For JDBC encryption, enter EncryptionMethod=SSL;ValidateServerCertificate=true;CryptoProtocolVersion=TLSv1.2
    • Binding the JDBC driver packages sometimes takes longer than the default login timeout. If this happens, enter LoginTimeout=180.
    • The default collection for binding JDBC driver packages is NULLID. You can change this setting with PackageCollection=collection_name.
    • To display additional information in the Db2 DDF Summary, enter ClientHostName=workstation_name;ClientUser=workstation_userid.
    • To enable the JDBC driver KeepAlive feature, see Network considerations between CDC Replication datastores and Db2 for z/OS.
    • For more details and more parameters, review the JDBC connection parameters for the DataDirect Driver.

    After you add extra parameters, press Enter.

  14. For user authentication, choose one of the following options:
    Option Steps
    External secret store with Java user exit To use an external secret through Java user exit authentication, enter Y and press Enter.

    You are prompted to enter the Java class name of the external secret store user exit, for example com.datamirror.ts.external.keystore.VaultExternalSecretStoreTest.

    1. Enter the case-sensitive database user key from the external secret store for the specified database and press Enter.
    2. Enter the case-sensitive database password key from the external secret store for the specified database and press Enter.

    For more information, see Creating an instance by using database credentials stored in an external secret store.

    User name and password
    1. Enter N and press Enter.
    2. Enter the user name for the specified database and press Enter.
    3. Enter the password for the specified database and press Enter. The configuration tool searches the database for schemas.
  15. Enter the user name for connecting to Db2 for z/OS and under which the configuration tool will run commands on z/OS. See Required Db2 and z/OS settings for additional information. Press Enter.
  16. Enter the password for that user name. The display is suppressed. Press Enter.
  17. Enter the database schema under which the stored procedure for log reading will be created. The schema is case sensitive and is typically uppercase. Press Enter.
  18. Enter the SSH port, or accept the default port. Press Enter.
  19. Enter the name of the Workload Manager (WLM) environment in which the stored procedure will run. Press Enter.
  20. Enter the fully qualified load library name without quotes in which the stored procedure load module will be created. See Required Db2 and z/OS settings for more details. Press Enter.

    The configuration tool creates the CDC Replication instance and prompts you to start the instance.

  21. Enter the high-level qualifier for the z/OS Language Environment, or accept the default prefix. Press Enter.
  22. Enter the high-level qualifier for the user, or accept the default prefix. Press Enter.
  23. Enter y to start the instance.

Results

Note: If the automatic configuration fails, you can manually install the external stored procedure.