Last updated: Nov 26, 2024
Deploy the Data Virtualization Remote Agent on Windows.
Procedure
- Download and install the Java Runtime Environment from IBM® SDK, Java Technology Edition, Version 8 from Java SDK downloads, version 8.0 or the appropriate version of Oracle Java SE 8. Take a note of the installation path to complete the next steps.
- Download the IBM Data Virtualization Remote Agent .zip file from IBM Data Virtualization Remote Agent.
- Unblock the Remote Agent archive by right clicking the .zip file, and then selecting Properties > General > Unblock.
- Extract the archive and take a note of the installation path. For example:
C:\Users\Administrator\WATSON_QUERY_REMOTE_AGENT_V2.1.3
Note: Ensure that the user who runs the remote agent has Read, Write, and Execute permissions on the directory.
- Open a text editor, and then create a new document with the following information. Enter
the remote agent installation path and the Java installation
directory.
For example:set DATAVIRTUALIZATION_INSTALL="<Remote agent installation path>" set JAVA_HOME="<Java installation directory>"
set DATAVIRTUALIZATION_INSTALL="C:\Users\Administrator\WATSON_QUERY_REMOTE_AGENT_V2.1.3" set JAVA_HOME="C:\Program Files\IBM\Java80\jre"
- Optional: To add memory or Kerberos configuration, complete the following tasks.
- To change the memory from the default of 256 Mb to 512 Mb, add the following line to the
file:
set JAVA_OPTS=-Xmx512m
- 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 thekrb5.ini
file.
For example:set KRB5_CONF_FILE=<File path to the krb5.ini>
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.
- To change the memory from the default of 256 Mb to 512 Mb, add the following line to the
file:
- Open the Windows Command Prompt App.
- Run the following command to change to the agent installation directory and to configure
the agent. Enter the value for each parameter as described in the following
table.
For example:cd <Remote agent installation path> config.bat -i "<Instance ID>" -c "<Configuration Hash>"
cd C:\Users\Administrator\WATSON_QUERY_REMOTE_AGENT_V2.1.3 config.bat -i "pre6e3c0-f94c-4f83-96bd-1004fbeff381" -c "Tm2IdX1tf20..."
Table 1. Parameters and parameter descriptions that you use to deploy the Remote Agent on Windows Parameter Description 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. - Install the Windows service to automatically start the Data Virtualization Remote Agent when the system starts.
- 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
- After you install the Windows service, exit the command prompt and return to the Data Virtualization web client.
- Navigate to the Data Sources tab and select Reload
Connections to view the Remote Agent. 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.