Skip to content

Installing on Unix

On the Micro Focus download site, choose the installer that identifies the operating system and version of Host Integrator that you want to install. Install programs are designated with either –prod for the production version or –eval for the evaluation version. Each installer performs the following steps, which cannot be executed individually:

  1. Installs the chosen products.
  2. Continues with the setup of the installed products.
  3. Configures the servers.

Interactive installation


These instructions are for a system without a current version of VHI installed. If you have a previous version of VHI installed, see the Upgrading on UNIX section.

In this example the Linux installer is used to install the production version (-prod) of Host Integrator.

To install Host Integrator components on UNIX systems:

  1. Log in as root. You can create a new non-root user and group specifically for running Host Integrator, such as vhiuser and vhigroup. To specify the user and group, use the --owner option. See Additional Installation and Configuration Options.

  2. Type the following command on the UNIX prompt: sh vhisrv-7.x.x-prod- sh vhisrv-7.x.x-prod-<linux> [--owner vhiuser:vhigroup]

  3. Use either the y or n command to respond to the license agreement. If you select n, the installation stops.

After selecting Yes, you can navigate the License Agreement using the following commands:

  • ENTER - Read the agreement line by line
  • SPACE - Read the agreement page by page
  • q - Quit reading and return to the menu.
  • n - Stop the installation.

  • Choose to initiate a Typical (t) or Custom (c) install process.

  • Typical - A standalone installation which includes all default components and configurations.

    • The session server and the management server are installed and the session server is automatically registered with the local management server.
    • Supply and verify an administrative password. This password is required for later configurations.
    • The installation continues with the default installation of all VHI components.
    • Installation proceeds with no option to “go back”.
  • Custom - In a custom installation you manually select components, join existing servers, and configure other required options from the configuration options menu. Continue customizing your installation, choosing the components you want to install.

  • To continue you must specify the following menu category options:

  • Components - To select or clear a component enter the corresponding number and press: ENTER. By default all components are selected.

  • Options - Installation location and owner. The default location is /opt/microfocus/verastream. To specify the owner:

    • Choose the owner (and optional group) for all files and directories under the base location where the product is being installed.
    • To specify a non-root user and group ownership use one of the following methods: menu option "o" in interactive custom installation, --owner option on the installer command line, or owner= line in the install-input file for an unattended automated installation.
    • Specify user or user:group

    After installation by root is complete, you can directly log in as the specified user to manage the product.

    • Actions - Specify whether to continue, quit or display help.


If there is still a partial VHI installation on the machine, the default value will hold the value from that installation. This is generally true for all configurable options and settings.

Depending on what components you selected, there may be further configuration needed:

If selected Do this
Host Integration Server To successfully install a Host Integration server you must either install a management server or join an existing installation.
Management Server or Host Integration Server and Management Server If you choose either of these scenarios, you can associate the management server with an existing management server cluster. You can combine this option with the registration of the Host Integrator Server, allowing for automatic replication to the management server cluster.
Any other combination of components The option c) continue will be changed to i) install

If the Host Integration Server is selected without a management server, you need to specify the following options to join an existing installation:

Verastream Host Integrator Version 7.x 
1) Management Server address: 
2) Management Server username: 
3) Management Server password:
i)   Install
q)   Quit
h)   Help
Make a selection:
- Server address - Enter 1 - The address is checked for format (Ex:, address and port number) and existence of the server.

  • Server username - Enter 2 - Either the built-in “admin” user, or another user that has been given administrator rights in the management server.

  • Server password - Enter 3 - (The password is neither echoed nor shown)


If a failure occurs while registering the management server, session server, or changing the password, check the log file located in the installation path for information.

When prompted to join an existing cluster, if you select yes, specify the configuration options in the screen below. See the previous table for a description of the commands.

Verastream Host Integrator Version 7.x 
1) Join an existing cluster: Yes
2) Management Cluster address: 
3) Management Cluster username: 
4) Management Cluster password: 
i)   Install
q)   Quit
h)   Help
Make a selection:
Run the i) install command to complete the installation.

Installing additional components

If you did not install all the components initially, you can re-start the installer and add components to an existing installation

Additional installation and configuration options

In addition to the traditional installation method you may elect to install from the UNIX command prompt where you have full control over the installation using the following commands:

  1. For a list of commands, type: sh vhisrv-7.x.x-prod-linux --help
  2. Use these commands to perform the following:
Command Description
basepath Choose another base installation location.
owner Choose the owner (and optional group) for all files and directories under the base location where the product is installed. This same owner is used to start all server processes. Specify user or user:group. After the installation by root it will be possible to directly log in as the specified user and manage the product.
licenseagreed The EULA license is not shown and the install program assumes you have read and accepted it. You can initiate a complete unattended install when --input is used.
input Specify a file that contains all necessary information to install the product without interaction. By default the install only outputs errors and warnings. Additionally if you specify --verbose the different executed steps are written to standard output.
createinput filepath When this option is used with an interactive install, all choices taken are written to the specified file. This file can next be used as input for a silent install.
verbose Provides detailed output when --input is specified.

In addition to the above commands the following commands are configurable. You can use these options to specify or override the default values as explained in the previous Interactive Installation section.

Configuration Command Description
join_cluster True or False
cluster_address Set the management cluster address in the format (address:port)
cluster_user Set the management cluster user name
cluster_password Set the management cluster password. Use this option if you do not want the management cluster password recorded in the input file. You must enter the password once at the start of the installation, and then the install is silent.
password Set the password

Examples using commands

sh vhisrv-7.x.x-prod-linux --owner vhi:vhigroup --basepath /opt/vhi

The above command specifies the owner and group used to start all server processes and manually specifies the installation path.

sh vhisrv-7.x.x-prod-linux --join_cluster true --cluster_address --cluster_user admin --cluster_password secretpassword

This is used to join an existing cluster by specifying the required credentials and cluster configurations.

Automatically start services

To configure the session server to run as a system daemon and have the services start automatically as system services, you need to add a script to your system init.d or rc.tcpip configuration.

These instructions will start all services, including the management server if it is installed.

Create a file called vhi containing the following and enter in your installation directory.

To start a particular service, replace the parameters with one of the following: - server —VHI session server - mgmtserver —VHI management server - logmgmr —VHI log manager - hostemul —VHI host emulator

# Provides: VHI
# Required-Start: $network
# Should-Start: $network
# Required-Stop: $network
# Should-Stop: $network
# Default-Start: 3 5
# Default-Stop: 0 1 2 4 6
# Description: Micro Focus Verastream Host Integrator Services
INSTALL_DIR=<enter installation directory>
case "$1" in
echo "Starting Verastream"
$BIN_DIR/atstart -start all
echo "Stopping Verastream"
$BIN_DIR/atstart -stop all
status) echo "Current Verastream status"
$BIN_DIR/atstart -status
restart) echo "Restart Verastream"
echo "-- stopping all components --"
$BIN_DIR/atstart -stop all
echo "-- starting all components --"
$BIN_DIR/atstart -start all
echo "Usage: $0 {start|stop|status|restart}"
exit $RETVAL
Select your platform and complete the following steps.

Linux and zLinux

  1. Copy the file to the /etc/init.d directory
  2. Set the file permission. Run chmod using the value 755. For example, chmod 755 vhi
  3. Run chkconfig to add the initialization script. For example, chkconfig --add vhi

To run the services as a non-root user, create a new script that will run the provided sample script.

Testing changes

You should test manually stopping and starting services while logged in as the non-root user and verify that services are automatically started after you restart the system.

  • For more information on manually starting and stopping Host Integrator services, see the online help topic, Starting and Stopping Services.

  • To verify services are successfully running, see Technical Note 7021540.

  • If services do not start successfully, check the operating system log as described in Technical Note 7021303, Operating System Logs section.

Local authentication requires root privileges

One of the Host Integrator processes may need to run as root, depending on your Host Integrator version and security configuration:

  • If you enable local OS groups in Administrative Console (Management > Directories > Properties), then the management server service, along with the other services, must run as root. However, this configuration is typically not necessary as VHI provides the following alternative for authentication security:
  • Secured administrative access using built-in “admin” user name and administrative password (set during installation or in Administrative Console).
  • Improved support for LDAP directory services, such as Microsoft Active Directory. You can add users and groups from your directory server to the Administrator, Developer, and User authorization profiles.
  • See Technical Note 7021354 for more information on this topic.

Creating an unattended install file

You may install VHI silently, by specifying all necessary installation and configuration options in a separate file. Assuming this file is called install-input, it is enough to type this command on the command line:

sh vhisrv-7.x.x-prod-linux --input install-input --licenseagreed


An ‘unattended install’ presumes that you have already accepted the software license agreement applicable to this product (most likely, in the course of a software download process, or an initial product installation). A copy of the software license agreement is provided in the root directory of the product, in case you wish to review it before proceeding with this setup. Optional switch --verbose provides additional output. By default only errors and warnings are shown.


File install-input (below) contains all previously described options and is a sample delivered with the installation. In this file all components are selected and all configuration options are commented out.

#Component selection
#Specify the action to perform when there is already a VHI installed
# Installation location
# basepath=/opt/attachmate/verastream
# Owner of installation and startup id servers
# owner=vhiuser:vhigroup
# Management Server values to register Session Server with another Management Server
# Does the Management Server join a Management Cluster?
# join_cluster=true
# Management Cluster configuration
# General username and password; for new or existing Management # # Server or Management Cluster
# server_username=admin
# server_password=secretpassword


  • If sessionserver, managementserver,hostemulator or connectors are set to true, the component is installed. If you set the value to false, add # in front of the option or leave the component out; the component will not be installed.
  • If a line begins with ‘#’, the option is ignored. In the example above all configuration options are commented out in this way.
  • If you use the example file above (if the comments are removed), the session server, web server, management server, Host Emulator, and connectors are installed. The management server is registered with cluster server and the session server is registered in the cluster through replication.
  • You only need to use the vms_address option when no management server is installed (managementserver=false). When that is the case the vms_address option specifies where to register the session server. Otherwise, this option is ignored. When the Host Emulator is installed along with the session server, it is registered to the same management server.
  • No interaction is necessary and no output is given unless an error occurs.

Uninstalling Host Integrator

To run the uninstall process follow the steps below:


The file is located in the Verastream Host Integrator installation directory.

  1. From the base installation directory, type: sh --sessionserver --managementserver
  2. Confirm the removal:

    • Choose yes to stop all servers and remove all files and directories including the base installation directory. When yes is chosen, all servers are stopped and all known files and directories in the base installation directory are removed. When the base directory is empty, the directory itself is also removed.

You can remove either the session server or the management server. See step 1 above and enter just -–sessionserver or --managementserver. This option only removes files and directories not being used by the remaining component.


The installer does not remove the registration of the session server or management server. You must make registration changes manually with the help of the Administrative Console.

Type sh --help to display the help screen if needed.

Micro Focus Verastream Host Integrator and/or Management Server uninstall
Remove all files from a prior installation,
including all configuration data that may be present.
Usage: ./ [options]
  --basepath path       : Base installation path
  --managementserver    : Remove Management Server
  --sessionserver       : Remove Host Integration Server
  --hostemulator        : Remove Host Emulator
  --connectors          : Remove Connectors
  --all                 : Remove all installed VHI components
  --verbose             : Detailed output 
  --yes                 : Answer yes to all questions
  --help                : Display this message.