[ Nav ] Incompatible combination of context ( icp4data ) and deployment_target ( cloud )

Deploying the Data Virtualization Remote Agent on Windows

Last updated: Mar 27, 2025
Deploying the Data Virtualization Remote Agent on Windows

Deploy the Data Virtualization Remote Agent on Windows.

Before you begin

You must have command-line access to the remote server where the Data Virtualization Remote Agent is going to be deployed.
Note: If you are using the Remote Agent to virtualize files on the remote server, then OS user restrictions apply. Also, running the Remote Agent with low privileges might limit its access to certain files on the disk.

Procedure

  1. Download and install the Java Runtime Environment from IBM® Java Semeru Certified Java 21 from IBM Semeru Runtimes Downloads. Take a note of the installation path to complete the next steps.
  2. Download the IBM Data Virtualization Remote Agent .zip file from IBM Data Virtualization Remote Agent.
    1. Unblock the Remote Agent archive by right clicking the .zip file, and then selecting Properties > General > Unblock.
    2. Extract the archive and take a note of the installation path. For example: C:\Users\Administrator\DATAVIRTUALIZATION_REMOTE_AGENT_V3.0.3_20250317_191028.tar.gz
      Note: Ensure that the user who runs the remote agent has Read, Write, and Run permissions on the directory.
  3. Open a text editor such as Notepad, and then create a new document. Enter the remote agent installation path and the Java installation directory as shown in the example below. 
    set DATAVIRTUALIZATION_INSTALL="<Remote agent installation path>" 
set JAVA_HOME="<Java installation directory>"
    For example:
    set DATAVIRTUALIZATION_INSTALL="C:\Users\Administrator\WATSON_QUERY_REMOTE_AGENT_V2.1.3" 
set JAVA_HOME="C:\Program Files\IBM\Java80\jre"
    Optional: To adjust the memory, proxy configuration, or Kerberosconfiguration, complete the following tasks.
    • Adjust the memory and proxy configuration by entering the appropriate values for each parameter in this configuration command. Refer to the following table for more information on parameter values.
      set JAVA_OPTS=-"<Java Options>" ./config.sh -i <Instance ID> -c v<Configuration Hash>
      Table 1. Parameters and parameter values that you use to adjust the memory and proxy configuration.
      Parameter Parameter values
      Java Options

      Enter Java Options for memory configuration or proxy support.

      To increase the memory configuration of the agent from 256 Mb to 512 Mb, enter JAVA_OPTS=”-Xmx512g”.
      Instance ID Enter the Instance ID from the Output values column. See Generating the configuration for the Data Virtualization Remote Agent.
      Configuration Hash Enter the Configuration Hash from the Output values column. See Generating the configuration for the Data Virtualization Remote Agent.
    • To allow the remote agent to access a Kerberos enabled data source, find the path to the krb5.ini file and then add the following line to the file. Enter the path to the krb5.ini file.
      set KRB5_CONF_FILE=<File path to the krb5.ini>
      For example:
      set KRB5_CONF_FILE=C:\ProgramData\MIT\Kerberos5\krb5.ini

    When you are done configuring the file, save it as a plain text file in the installation directory you created and name it as datavirtualization.env.bat.

    Windows service uses this file when you start the agent.

  4. Open the Windows Command Prompt App.
  5. Run the following command to change to the agent installation directory and to configure the agent after replacing the value of each parameter as described in the following table. 
    cd <Remote agent installation path> config.bat -i "<Instance ID>" -c "<Configuration Hash>"
    For example:
    cd C:\Users\Administrator\WATSON_QUERY_REMOTE_AGENT_V2.1.3 config.bat -i "pre6e3c0-f94c-4f83-96bd-1004fbeff381" -c "Tm2IdX1tf20..."
    Table 2. Parameters and parameter values that you use to deploy the Remote Agent on Windows
    Parameter Parameter values
    Remote Agent installation path Enter the installation path for the Remote Agent.
    Instance ID Enter the Instance ID from the Output values column. See Generating the configuration for the Data Virtualization Remote Agent .
    Configuration Hash Enter the Configuration Hash from the Output values column. See Generating the configuration for the Data Virtualization Remote Agent.
  6. Install the Windows service to automatically start the Data Virtualization Remote Agent when the system starts.
  7. Run the following command from the command prompt window to install Data Virtualization on the Windows system. Enter the port number that the Remote Agent service is configured to use, as well as the Administrator password. 
    install_dv_service.bat -p <Port number> -s <User password>
    For example:
    install_dv_service.bat -p 6414 -s abc123
  8. After you install the Windows service, exit the command prompt and return to the Data Virtualization web client.
  9. Navigate to the Data Sources tab and select Reload Connections to view the Remote Agent.

What to do next

After you deploy the Remote Agent, proceed to start the agent manually for immediate use or configure it as a system service to start automatically.

To manually start the agent, see Manually starting the Remote Agent on Linux.

To automatically start the agent, see Automatically start the Remote Agent by adding a systemctl service on Linux.