Introduction

With workers now having the ability and choice to work from home, VSM Everywhere provides customers and business partners with a tool to help monitor and diagnose unmanaged systems that are active outside of an office environment.

Setting Up VSM Everywhere

What You Will Need

Before installing the VSM Everywhere client you will need the following:

• An up-to-date collector that has connected to the Virsae platform and is reachable by remote workers or a Virsae Cloud Collector
  • If you are using a Windows-based VSM Collector for VSM Everywhere, you will need to use the Client Gateway 2 version.
• A copy of the silent installer.
• A VSM Everywhere profile group configured in the web portal
• Administrator-level permissions on the machine where the VSM Everywhere client will be installed.

Getting What You Need

If you do not have one or any of the above-mentioned requirements, the following sections will provide instructions on how to meet these requirements.

Configuring A Collector

With the introduction of VSM Everywhere, VSM customers and business partners have been given the ability to configure more than one collector under the same location.

To set up an additional collector under a single location, simply follow the same steps that are described in this article with the new collector.

Getting the Silent Installer

Contact your VSM Administrator for a copy of the VSM Everywhere installer package.

Configuring a VSM Everywhere Profile Group

See the Web Portal Configuration section to learn about configuring profile groups.

Getting Client Gateway 2 (If using a Window-based VSM Collector)

See this article for information on how to get and set up a Client Gateway 2 VSM Collector.

For a Client Gateway 2 VSM Collector, the process detailed in the article above is the same, however, you will need to complete the install using the file named: VSM Software CGW2MP2 Mar 2021.zip

Web Portal Configuration

Before a VSM Everywhere client can start tracking the performance of a system, it must first know what it needs to track.

Go to the Virsae Web Portal and then navigate to Service Desk > Equipment Locations > VSM Everywhere.

Customer Access (To Equipment Locations)

Business Partner Access (To Equipment Locations)

VSM Everywhere Access (From Equipment Locations)

After reaching the page, you will see the following.

A group represents a set of tracked metrics that the VSM Everywhere client will track.

Let's configure a group, click the "+" button at the bottom of the group list to begin adding a new group.

Enter a group name and choose which metrics you want to track.

The table below describes what each option represents.

Default groups have a tick beside their name in the side navigation bar.

You can edit groups at any point by pressing the "Edit Group" button. All fields are editable.

You can also delete groups at any time. All groups are deletable.

Installing VSM Everywhere

After everything has been set up, to install VSM Everywhere, use the MachineProxyAgentE_Installer.msi to install via a command-line interface.

The installer accepts all of the default command line arguments provided by an MSI, as well as two additional arguments: CGWS and GROUP.

You can use either Command Prompt or PowerShell to install.

Installing Via Command Prompt

To get started with the installation we need to open Command Prompt in administrator mode.

First, press the Windows Key on your keyboard or click the Start icon on your taskbar.

Next search for "Command Prompt".

Find the "Command Prompt" option in the results.

Next press "Run As Administrator"

After opening the command-line interface, use the Installation Commands section to create an installation string.

Install Via Powershell

To get started with the installation we need to open Powershell in administrator mode.

First, press the Windows Key on your keyboard or click the Start icon on your taskbar.

Next search for "Powershell".

Find the "Powershell" option in the results.

Next press "Run As Administrator"

After opening the command-line interface, use the Installation Commands section to create an installation string.

Install Via Microsoft Intune

Prepare a Win32 App For Intune

To install the VSM Everywhere client using Microsoft Intune, you will need to convert the .msi installer into the .intunewin type.

Follow the instructions detailed inside of the Prepare Win32 app content for upload article with the MachineProxyAgentE_Installer.msi installer.

Add A Win32 App

Once the .intunewin file has been created, we can add it to Microsoft Intune which will automate the installation of the VSM Everywhere client to devices.

Use the Add, assign, and monitor a Win32 app in Microsoft Intune tutorial to add the installer to Microsoft Intune.

For "Step 2: Program", in the above tutorial, use the Installations Commands section on this page to define your install and uninstall commands.

 msiexec /x "{FCC97786-7AD7-49B0-98C2-131F864C6BA1}"

For "Step 4: Detection Rules", use the "File" option and check for the folder "C:\Program Files\Virsae Group\Machine Proxy Agent E".

Collecting Logs

If an installation fails, use the Win32 app installation troubleshooting guide to collect logs from where you have defined logs to be sent in the installation command that was defined

in the Add a Win32 App section.

App Availability and End User Notifications

To control what notifications an end-user receives and when the VSM Everywhere client should be installed by, see the section linked here: "Set Win32 app availability and notifications".

Installation Commands

To install the VSM Everywhere client, via your preferred command-line interface, use the following lines:

// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart

//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/i C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart' 

// Command Prompt
> cd "C:\Path\To\Installer\Location"

// Powershell
> Set-Location 'C:\Path\To\Installer\Location'

See the sections below to enable installation logging, set which collector the VSM Everywhere client should connect to, and what group the client should be a part of.

Enable Installer Logging

A full list of logging options are available here.

For ease of reference, you can activate verbose logging using the /L*v switch.

// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\install.log"

//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/i C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart /L*v C:\path\to\install.log'

CGWS Argument

CGWS takes a semi-colon separated list of IP addresses or Fully Qualified Domain Names (FQDNs) that represent the location of collectors that a VSM Everywhere client can connect to.

VSM Everywhere has the ability to connect to multiple collectors in case one collector is unreachable or overcapacity.

You can also specify which port to connect by using a colon after the IP Address/FQDN, e.g. 192.10.10.10:6226 will specify that the VSM Everywhere client should connect to the collector on port 6226.

If no port is specified the default port of 8444 will be used.

// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\install.log" CGWS="192.10.10.10:6226;192.10.10.15:2662"

//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/i C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart /L*v C:\path\to\install.log CGWS=192.10.10.10:6226;192.10.10.15:2662'

GROUP Argument

The GROUP argument takes the group name of a group configured inside of a web portal. If VSM Everywhere is installed with no group name, or if the collector could not find the requested group, the default group will be used instead.

// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\install.log" CGWS="192.10.10.10:6226;192.10.10.15:2662" GROUP="NZ/AUS"

//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/i C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart /L*v C:\path\to\install.log CGWS=192.10.10.10:6226;192.10.10.15:2662 GROUP=NZ/AUS'

Uninstall Command

To uninstall the VSM Everywhere Client from a command line, use one of the following commands.

// Command Prompt
> msiexec /x "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\uninstall.log"

//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/x C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart /L*v C:\path\to\uninstall.log'

Changing Communication Port Between Collector and VSM Everywhere (Optional)

In order for the VSM Everywhere client to connect on a port that is not 8444, you will need to change the port that a VSM Collector listens on.

The documentation below details this process for both Linux Virtual Machine (VM) and Windows-based collectors.

Changing Listening Port For a Linux-based Collector

Open a console session to a Linux VM.

Stop the VSM Client Gateway by typing the following command:

$sudo systemctl stop clientgateway.service

Next, type:

$sudo nano /opt/ADSClientGateway/ADSServiceHost.cfg

This will open up the Client Gateway configuration file.

Find the configuration item with the key "Client Gateway Server Port"

Update the number inside the Value tag to your required port number.

Once all changes have been made, save the change press 'Ctrl+O' and then press 'Enter' to write out the changes. To close the 'nano' editor press 'Ctrl+X'.

Once the changes have been saved, restart the Client Gateway by entering the following:

$sudo systemctl start clientgateway.service

Changing Listening Port For a Windows-based Collector

Access the Windows Machine that contains the Windows-based VSM Collector

Open Notepad.exe as an administrator and then open the ADSServiceHost_UCSP_Client_Gateway.cfg file. The default path to the configuration file is C:\Program Files\Virsae Group\Client Gateway).

Search for <Key>Client Gateway Server Port</Key> and in the line below this

Change the value between the Value tags from 8444 to your required port number.