System Configuration for HVR Agent on Unix
This section describes the system configuration required for an HVR Agent installed on Unix. The steps mentioned on this page are normally performed while Installing HVR Agent on Unix (step - Configure the system for HVR Agent).
There are different ways for configuring the HVR Agent to listen on a TCP/IP port:
- Unix inetd
Standard on older Unix distributions. Requires root privilege. - Solaris Service Management Facility (SMF)
Used on Solaris (versions 10 and higher) distributions. Requires root privilege. - HVR Agent Listener
Our own daemon hvragentlistener. Does not require root privilege.
Unix inetd
The following steps should be performed as user root to configure the inetd service:
In the /etc/services file, add the following line specifying the name (e.g. myhvr) and the TCP/IP port number of the HVR Agent:
myhvr 4343/tcp #Port for HVR Agent
Add the following line to /etc/inetd.conf file:
myhvr stream tcp nowait fivetran /home/fivetran/hvr_home/bin/hvragent hvragent -EHVR_HOME=/home/fivetran/hvr_home -EHVR_CONFIG=/home/fivetran/hvr_config -EHVR_TMP=/home/fivetran/hvr_tmp
- The user must be set to the user (e.g. fivetran) under which HVR Agent is installed/running.
- The service name (e.g. myhvr) specified in this inetd.conf file must match with the name specified (step #1) in the /etc/services file.
- The above configuration should be defined in a single line (without manual line break).
Option
-E
defines the environment variables.Reload or restart the inetd service to apply the changes. For information about restarting the inetd service, refer to the operating system documentation.
Solaris Service Management Facility (SMF)
In Solaris 10 and higher, the /etc/inetd.conf file has been replaced by SMF manifests. All inetd services are now configured/controlled under the SMF. The following steps should be performed as user root to configure the SMF service:
In the /etc/services file, add the following line specifying the name (e.g. myhvr) and the TCP/IP port number of the HVR Agent:
myhvr 4343/tcp #Port for HVR Agent
Create a temporary file (e.g. /tmp/inet.hvr) containing the following inetd.conf-style entry for the HVR Agent:
myhvr stream tcp nowait fivetran /home/fivetran/hvr_home/bin/hvragent hvragent -EHVR_HOME=/home/fivetran/hvr_home -EHVR_CONFIG=/home/fivetran/hvr_config -EHVR_TMP=/home/fivetran/hvr_tmp
- The user must be set to the user (e.g. fivetran) under which the HVR Agent is installed/running.
- The service name (e.g. myhvr) specified in this temporary file must match with the name specified (step #1) in the /etc/services file.
- The above configuration should be defined in a single line (without manual line break).
Option
-E
defines the environment variables.Import the temporary file (e.g. /tmp/inet.hvr) into System Management Facility (SMF) using the command inetconv.
For example:inetconv -i /tmp/inet.hvr
Enable the service using the command inetadm.
For example:inetadm -e svc:/network/hvr/tcp:default
Refresh the service using the command svcadm:
svcadm refresh inetd
HVR Agent Listener
The command hvragentlistener should be executed with option -d
to start the HVR Agent Listener service as a daemon process on the required port:
hvragentlistener -d 4343
Testing Connection to a HVR Agent
To test the connection to an HVR Agent, execute the command hvragenttest on the machine from which you are connecting to the HVR Agent. You can also check whether hvragentlistener is running by executing the command hvragenttest directly on the HVR Agent machine.
Following are few examples for testing the connection to an HVR Agent.
Example 1: Check connection to a HVR Agent
You can check the connection to an HVR Agent installed/running on a remote machine with username and password authentication enabled. Execute the following command on the hub machine or on the machine from which you are connecting to the HVR Agent:
hvragenttest -L myuser/mypassword mynode 4343
Sample output in Linux with successful authentication and also indicating that the HVR Agent Listener is running:
hvragenttest: Fivetran 6.1.0/21 (linux_glibc2.17-x64-64bit) hvragenttest: Agent version 6.1.0/21. hvragenttest: Authentication with username and password enabled. hvragenttest: Authentication successful. hvragenttest: Finished. (elapsed=0.34s)
Example 2: Check whether hvragentlistener is running
After installing and starting the HVR Agent Listener service, you can verify whether the hvragentlistener is running on the agent machine. Execute the following command on the agent machine:
hvragenttest mynode 4343
Sample output in Windows with successful authentication indicating that the HVR Agent Listener is running:
hvragenttest: Fivetran 6.1.0/21 (windows-x64-64bit) hvragenttest: Agent version 6.1.0/21. hvragenttest: Authentication with username and password enabled. hvragenttest: Authentication successful. hvragenttest: Finished. (elapsed=0.18s)