Activating Sites with On-Premises


Viakoo OnPremise Site Activation


This document augments the Initial Setup Documentation found in the Viakoo Knowledge space and is only for Viakoo OnPremises Customers who are activating sites to be supported through their private configuration of Viakoo OnPremises.

These additional steps are needed because the default configuration of the Communications Agent (CA) is to the Viakoo Service in the Viakoo Data Center and not your local, Viakoo OnPremise instance.


This section summarizes what is needed. How to get the right values for each is explained in the sections below.

  • Get Activation Key from Viakoo OnPremise instance: _____________________________
  • Get path or IP address for Viakoo OnPremise API Server (VOPapi) (defined in Viakoo OnPremise Jumpstart Checklist):
    • Full path in DNS service: ViakooAPI._________________________________      (e.g., “”)
    • OR IP address:                                         _____._____._____._____
  • Download Agents:
    • Download & Install Reader Agents (RAs) to each server to be monitored.
    • Download & Install the Communication Agent (CA) to the site management server.
  • Redirect the Viakoo reader IP Address to the be the VoP ViakooAPI server from the ViakooCA console.
  • Then follow standard instructions to do Initial Setup

Activation Key

Log into your Viakoo OnPremise service and navigate to the location you want to have the site report into. For most, this will just be your Company at the top level. However, if you have created Regions, navigate to the appropriate region for the given site.

Now click on the “Details” tab. In the top box, you will find a “Key” entry followed by a long string.


You can also navigate to “Company Management” window from the main, pull-down menu.


Then find the Activation Key for your Company or the correct Region.


This key is needed to establish a secure connection between your site’s Communication Agent (CA) and your Viakoo OnPremise Service during Site Activation.

Download Viakoo Agents:

Navigate in your web browser to the Latest Agents URL

Install Reader Agents (RA) on each Server

Download a copy of the latest version of the Reader Agent for each server you want to include in your Viakoo-monitored configuration. This should also include the server you want to use as the communication server (i.e., server which hosts the Communication Agent (CA)).

There are two versions:

  • ViakooRA.*.exe for Windows systems
  • viakoora.*.run for Linux systems

For each of these servers, execute the appropriate ViakooRA.*.exe or viakoora.*.run file to install the RA software and start it running.

Install Communication Agent (CA) on your Communication Server

Select one server in your infrastructure that has network access to both your Viakoo OnPremises service as well as each of your servers you wish to manage through your Viakoo service.  This often is a Management Server used to manage a site’s configuration.

The ViakooCA is available in two installers:

  • ViakooCA.*.exe for Windows systems
  • viakooca.*.run for Linux systems

Download the appropriate ViakooCA installer file to your chosen system and execute it. After completing the installation, you are now ready to activate the site from the CA console.


Modifying the CA URL to Point to Viakoo OnPremise

Changing the path to the Viakoo Service

Instead of beginning the activation immediately, Viakoo OnPremise customers need to change the IP path the CA uses to talk to the Viakoo service. By default, the CA is configured to talk to the Viakoo hosted datacenter. When you reach the activation screen, you need to change your connection settings to point to your Viakoo OnPremises API Server. 

Navigate to the ViakooCA's server as you would normally (e.g., http://localhost:10101).Connection_Settings.png

Click the link to "set your Viakoo Location" which will take you to the "Connection Settings" page.


In the space provided, enter the URL to reach the data reader in the Viakoo OnPremise API Server. The URL will have the following structure:

http://<ip address or hostname of api server>

Or if SSL is enabled, 

https://<hostname of api server>

Reader Path If Using DNS Service

If ViakooAPI is defined in your DNS service (e.g., ActiveDirectory, LDAP service or through a ViakooProxy VM), you can use that name in the address portion of the URL. You may have to use a full path such as:

where, is your top-level organization’s domain, and mysecuritynetwork, is the subdomain path within your organization so that the ViakooAPI name can be resolved anywhere in your organization.

If you have configured the ViakooAPI server in your namespace, the URL might be:

Reader Path Using IP Address

If you did not set up the ViakooAPI name in your DNS service, you can just use the IP address allocated to this server in your VMware configuration:


For example, if the IP address of the Viakoo OnPremise API Server is “” the URL to put in the field would be:

After clicking "Submit" you will see the display test this connection to verify that it can reach the Viakoo service at that location. If you see a green check box next your link, "Continue Agent Setup" to return to the site activation page.


Go to First Steps->Initial Setup for instructions for completing Site Activation.

Have more questions? Submit a request


Powered by Zendesk