This documentation is for an older version of HVR.

Hvrremotelistener

Name

hvrremotelistener - HVR remote listener.

Synopsis

hvrremotelistener [-options] portnum [access_conf.xml]

Description

HVR remote listener listens on a TCP/IP port number portnum and invokes an HVR process for each connection. The mechanism is the same as that of the Unix/Linux daemon inetd, xinetd or systemd.

On Windows, HVR remote listener is a Windows Service which is administered with option -a. The account under which it is installed must be member of the Administrator group, and must be granted privilege to act as part of the operating system (SeTcbPrivilege). The service can either run as the default system account, or (if option -P is used) can run under the HVR account which created the Windows Service. For more information about creating/starting HVR remote listener service on Windows agent machine see, Configuring Remote Installation of HVR on Windows.
On Unix and Linux, HVR remote listener runs as a daemon which can be started with option -d and killed with option -k. For more information about configuring HVR remote listener on Unix/Linux agent machine see, Configuring Remote Installation of HVR on Unix or Linux.

Optionally, after the port number portnum an access configuration file access_conf.xml can be specified. This can be used to authenticate the identity of incoming connections using SSL.

In a IPv4/IPv6 mixed system, if an IP restriction is defined in the access_conf.xml file, then in the hvr.socket file (see Configuring Remote Installation of HVR on Unix or Linux) set ListenStream=0.0.0.0:4343 to force systemd to use IPv4.

For example, the following contents will restrict access to only connections from a certain hub machine whose IP address is 54.93.183.20:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hvraccess SYSTEM "hvraccess.dtd">
<hvraccess>
  <allow>
    <from>
      <host>54.93.183.20</host>
      <ssl remote_cert="HVRHubCertificate"/>
    </from>
  </allow>
</hvraccess>

HVR remote listener is supported on Unix and Linux but it is more common on these machines to start remote HVR executables using the system process (inetd, xinetd or systemd). For more information, see Configuring Remote Installation of HVR on Unix or Linux.
When HVR remote listener is executed as a Windows service the errors are written to the Windows event log (Control Panel ▶ Adminitrative Tools ▶ Event Viewer ▶ Windows Logs ▶ Application).

Options

This section describes the options available for command hvrremotelistener.

Parameter	Description
-ax `Windows`	Administration operations for Microsoft Windows system service. Values of x can be: c : Create the HVR remote listener system service. s : Start the HVR remote listener system service. h : Halt (stop) the system service. d : Destroy the system service. Several -ax operations can be supplied together; allowed combinations are: acs : Create and start HVR remote listener service or ahd : Halt and destroy HVR remote listener service or HVR remote listener service can also be started and halted from the Windows Services console (accessible from Control Panel ▶ Administrative Tools ▶ Computer Management ▶ Services and Applications ▶ Services). The shortcut command to access this console is services.msc. Using this option without option -P may require administrator privileges. In this case, it is recommended to use Run as administrator option while opening the Windows command line terminal.
-A	Remote HVR connections should only authenticate login/password supplied from hub, but should not change from the current operating system username to that login. This option can be combined with the -p option (PAM) if the PAM service recognizes login names which are not known to the operating system. In that case the daemon service should be configured to start the HVR child process as the correct operating system user (instead of root). In Windows, this option is available only in CLI (an equivalent GUI option is not available in Create Windows Service dialog).
-cclus\clusgrp `Windows`	Enroll the remote listener service in a Windows cluster named clus in the cluster group clusgrp. Once the service is enrolled in the cluster it should only be stopped and started with the Windows cluster dialogs instead of the service being stopped and started directly (in the Windows Services dialog or with options -as or -ah). In Windows, failover clusters clusgrp is the network name of the item under Services and Applications. The group chosen should also contain the remote location; either the DBMS service for the remote database or the shared storage for a file location's top directory and state directory. The service needs to be created (with option -ac) on each node in the cluster. This service will act as a 'Generic Service' resource within the cluster. This option must be used with option -a.
-d `Unix & Linux`	Start hvrremotelistener as a daemon process.
-Ename=value	Set environment variable name to value value for the HVR processes started by this service.
-i	Interactive invocation. HVR remote listener stays attached to the terminal instead of redirecting its output to a log file.
-k `Unix & Linux`	Stop hvrremotelistener daemon process.
-Kpair	SSL encryption using two files (public certificate and private key) to match public certificate supplied by /SslRemoteCertificate. If pair is relative, then it is found in directory $HVR_HOME/lib/cert. Value pair specifies two files; the names of these files are calculated by removing any extension from pair and then adding extensions .pub_cert and .priv_key. For example, option -Khvr refers to files $HVR_HOME/lib/cert/hvr.pub_cert and $HVR_HOME/lib/cert/hvr.priv_key.
-N	Do not authenticate passwords or change the current user name. Disabling password authentication is a security hole, but may be useful as a temporary measure. For example, if a configuration problem is causing an 'incorrect password' error, then this option will bypass that check.
-ppamsrv** `Unix & Linux`	Use Pluggable Authentication Module pamsrv for login password authentication of remote HVR connections. PAM is a service provided by several Operation Systems as an alternative to regular login/password authentication, e.g. checking the /etc/passwd file. Often -plogin will configure HVR child processes to check passwords in the same way as the operating system. Available PAM services can be found in file /etc/pam.conf or directory /etc/pam.d.
-Ppwd `Windows`	Configure HVR remote listener service to run under the current login HVR account using password pwd, instead of under the default system login account. May only be supplied with option -ac. Empty passwords are not allowed. The password is kept (hidden) within the Microsoft Windows operating system and must be re-entered if passwords change.
-Uuser	Limits the HVR child process to only accept connections which are able to supply the password for account user. Multiple -U options can be supplied.

Examples

Example 1: Run HVR remote listener interactively

Command to run hvrremotelistener interactively in the terminal and listen on port number 4343.

hvrremotelistener -i 4343

In this method, exiting the shell/terminal will terminate the HVR remote listener.

Example 2: Run HVR remote listener as daemon process in Linux/Unix

Command to run the hvrremotelistener as daemon process in Linux/Unix and listen on port number 4343.

hvrremotelistener -d 4343

Example 3: Stop/kill HVR remote listener running as daemon process in Linux/Unix

Command to stop/kill the hvrremotelistener that is running as daemon process and listening on port 4343.

hvrremotelistener -k 4343

Example 4: Create and start the HVR remote listener as a Windows service

Command to create and run/start the hvrremotelistener as a Windows service and listen on port number 4343.

hvrremotelistener -acs 4343

Example 5: Stop and destroy the HVR remote listener service in Windows

Command to halt and destroy the hvrremotelistener that is running as a Windows service and listening on port number 4343.

hvrremotelistener -ahd 4343