Upgrading the Data Virtualization Remote Agent on Windows

Upgrade the Data Virtualization Remote Agent on Windows.

About this task

If you installed the remote agent from a previous version of Data Virtualization and then upgraded to the newest version of Data Virtualization, ensure you complete this task to upgrade the remote agent.

Procedure

  1. Log in to the Windows virtual machine where the remote agent is running. Then in Services, stop the DataVirtualizationService (with the port suffix).
  2. Conditional: If you do not have Java 21 installed from the previous version of the remote agent, then install it on your Windows virtual machine. See System requirements for configuring the Data Virtualization Remote Agent.
  3. Back up all of the contents from the original remote agent folder into another folder.
  4. Delete all the contents from the original remote agent directory, and then extract the contents of the patch DATAVIRTUALIZATION_REMOTE_AGENT_V3.2.1_20251020_123451.zip file into the original remote agent directory.
    Note: Ensure you unblock this zip file before you extract it. See Unblocking files downloaded from the Internet.
  5. From the backed up folder, copy the .bat files into the new remote agent folder.
  6. In the datavirtualization.env.bat file, update the JAVA_HOME value with the Java 21 path. Ensure you remove new lines and unwanted spaces from the file. For example:
      set DATAVIRTUALIZATION_INSTALL="C:\Users\Administrator\Endpoint"
  set JAVA_HOME="C:\Program Files\Java21\jdk-21.0.6"
    Note: You do not need to update the DATAVIRTUALIZATION_INSTALL path.
  7. Navigate to the IBM Cloud Data Virtualization console, then in RunSQL run the following command.
    • Replace <RA_NAME> with the name of your remote agent.
    • Replace <RA_NAME_SC> with the name of your remote agent for the Satellite connector.
    • Replace <SC_ENDPOINT> with the Satellite connector endpoint.
    • Replace <SC_PORT> with the Satellite connector port number.
    call dvsys.generateconfighash('<RA_NAME>', '<RA_NAME_SC>', port, 7777,'peerAuthentication', null, -1, -1, 'DV_EXTERNAL_NODE_HOSTNAME_PORT=<SC_ENDPOINT>:<SC_PORT>',?,?,?);
    For example:
     call dvsys.generateconfighash('SC_RA_CLOUD', 'RA for satelite connector', 6416, 7777,'peerAuthentication', null, -1, -1, 'DV_EXTERNAL_NODE_HOSTNAME_PORT=c-01.private.us-south.link.satellite.test.cloud.ibm.com:44612',?,?,?);
  8. Open the Windows terminal in the remote agent directory.
  9. In the terminal, run the following command. Replace <INSTANCEID> and <CONFIGHASH> with the INSTANCEID and CONFIGHASH output values from step 7. This step configures your remote agent so that it connects successfully to your Data Virtualization formation.
    .\config.bat -i <INSTANCEID> -c <CONFIGHASH>
    For example:
    .\config.bat -i 705302ff-0c68-42c0-bcdc-f7238434e58b -c 3lmL8n1tf20KAQAQOk07Xu/xqn9DIfErjBl3Azsbgwq5ZF4wHG8rW1iwHf8BzJ1zR1PCq4T9aKDnTpaXOks7SqQh51g+iSk2VZ6EFa3heT6TXmYR9BHOqIPFKknb3HDm6SXX7qyrLcBS5MkaW1L7YZ2KPTBGPDMnLA6LeCquduDJjTrrF+/naqGmjJz2QoHbKgEKbVYAuysitqqr8RQ3Yvfz9A3VsG77f4A8GsX8Pt7ucwDGeK92KrNxcDPElY9gKTtI5PWtWtdNPRDxSbxiNd1M/rYaN0Xv5QCrn54nXaOSVaRV44zVDTPmWtBc10SCwhI33sG2irUDwoBdSAXhEw6JjDBMNvbZ+ymKct1Ll7V2IJQSBngyAguwynVT29qt62d/iOvwoE7SNy50Tlx1YnrXHCjiSgGyxHA1YK1paqX+8TbiSZhaehOG9ISM6HBLpVonFl27/g3afdsNXXetCOHxF5VPQINY9kjlMA/0u2ziIFmjvz8Xo3aA5YRLl/LRzmbdNSPhB3St1BmPR504uUlVA01JZdUH9Gzo7HTQyvYh/xhjx18cDZYn1Lg2XmT9FZBAg3kOqRD8Tzax/XVZNh7TXVsiIXHrE43eGsf616o/ivZmTuTCjmpuNd3KABMPtx3p51YfvPZtjz6VX/IW2vOmOhV6Pg0fOmw/Kcl8EdSm1X0XbiJ3mvEQ1gjzYK2yv+15XuV2o0MIPFECJzNR4cJlFkI6va4C+oMqKSPXWxtPv2XxcZRxk+nh9uDr1QUTeTDfhftlcQKDKk+//M0d4RuT+Ewiv4FmwmMLZV4UClQp9twjQH4Y4Er7dQFGIOZsMlicoxLsxhJaL/iKC0onidd7dfK0DOjFywSmpS7AhDQ=
  10. Start your remote agent service and verify that your remote agent is now successfully connected to your Data Virtualization formation.
    Note: If this step fails, then contact IBM support and do not proceed to the next steps.
  11. Stop your remote agent service.
  12. Replace all of the contents from the original sysroot\data remote agent folder with the contents from the backed up sysroot\data folder.
    1. In gaiandb_config.properties, replace: 
      EXTENDER_CLASS_NAME=com.ibm.gaiandb.confluence.ConfluenceExtender
      with the following: 
      EXTENDER_CLASS_NAME=com.ibm.gaiandb.queryplex.ConfluenceExtender
    2. In derby.properties, replace: 
      derby.authentication.provider=com.ibm.gaiandb.confluence.DVAuthenticator
      with the following:
      derby.authentication.provider=com.ibm.gaiandb.queryplex.DVAuthenticator
  13. In Windows Services, start the DataVirtualizationService and then verify that the remote agent is connected to your Data Virtualization formation.