...

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

...

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

• A Virsae Cloud Collector and the URL for this collector
  • PC's that will have VSM-E installed will require outbound internet access to the Cloud Collector URL on TCP port 443 using HTTPS, and the Ookla Speedtest server network on TCP port 8080 using HTTP and HTTPS
  An up-to-date collector that has connected to the Virsae platform and is reachable by remote workers
  • .
• A copy of the silent VSM-E installer.
• A VSM Everywhere profile group configured Configured a group in the web portal
• Administrator-level permissions on the machine where the VSM-E client will be installed.
• If you are wanting to use a Windows-based VSM Collector for VSM Everywhere, you will need to use a Client Gateway 2 version.

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.

Configuring a Cloud Collector

The VSM-E client is designed to communicate with a VSM Cloud Collector. Click here for instructions on setting up an Equipment Location with the 'Appliance' type set to Virtual (Virsae Cloud).

Once a VSM Cloud Collector has been administered please contact support@virsae.com to request the URL for this 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

...

Installer

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

Configuring a Group

See the Web Portal Configuration section to learn about configuring 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

...

The VSM-E installer is available in 'Service Desk> Files and Folders' - Then navigate to 'Shared with me> Virsae> VSM>VSM Software> VSM-Everywhere'

Image Added

System Requirements

Configuring Profile Group for VSM Everywhere 

Before a VSM-E

...

Before a VSM Everywhere client can start tracking the performance of a system, it must first know what metrics it needs to track. This is determined by creating a VSM-E Profile Group.

Go To create a Profile Group go to the Virsae VSM Web Portal and then navigate to Service Desk > Equipment Locations > VSM Everywhere.

Customer

...

View menu ( Service Desk > Equipment Locations):

Business Partner

...

view (from Customer tile > Service Desk > Equipment Locations):

Select VSM Everywhere

...

(

...

from the required Equipment

...

Location):

After reaching When on the Profile Groups page for the first time, you will see the following.

Image Removed

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

...

"No Profile Groups Found"

1. To configure a profile group, click the "+" button at the bottom of the group list to begin

...

1. creating a new group

...

2. Enter a

...

1. Group Name and
2. Choose which metrics you

...

1. wish to track by selecting Enabled and then the desired metrics
2. Once complete click the 'Add Group' button

Image Added

A Profile Group represents a set of metrics that the VSM-E client will track:

Image Added.Image Removed

The table below describes what each option represents.

The Default group will have a tick beside the 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.

...

...

A collector MUST have a default group.

As such, you can only REPLACE default groups when editing.

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.

Image Removed

Next search for "Command Prompt".

Image Removed

Find the "Command Prompt" option in the results.

Image Removed

Next press "Run As Administrator"

Image Removed

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.

Image Removed

Next search for "Powershell".

Image Removed

Find the "Powershell" option in the results.

Image Removed

Next press "Run As Administrator"

Image Removed

VSM Everywhere can be deployed to each target machine manually via an installation package or automatically via a software deployment tool such as Microsoft Intune.

Both methods are detailed below:

Manual Installation

Obtain the latest installation package via your Virsae Service Delivery Manager or support@virsae.com. 

The installation  will be within a ZIP file which you must extract. To do this right click on the ZIP file and select 'Extract All...' you will then be prompted to confirm the directory to extract the files to, most times the default suggestion will be fine.

Image Added

Once the files are extracted right click on the setup.exe file and then select 'Run as administrator'.

You may be presented with a Windows User Account Control dialogue warning this installation is from an unknown publisher. If you cannot confirm the source of the install files is Virsae, then please do not continue, otherwise let the installation continue.

Image Added

You will then be presented with the installer title page, click 'Next' to continue.

Image Added

The end user license agreement will be presented. Once you have read and accept this please check the 'I accept...' box and then click 'Next' to continue.

Image Added

The default installation location will then be presented. For most installations this location will be fine, however if you wish to install to a different location please modify this then click 'Next' to continue.

Image Added

Next you will have the opportunity to enter proxy details if required, or continue without a proxy. Click 'Next' to continue.

Image Added

Next you will be able to select the use of the Virsae Self signed Certificate (this is the default and will be used in most cases) or you can select to use the Virsae CA signed Certificate or a Custom Certificate, both of these options will require the Virsae Support team to work with you.

• Use Virsae self-signed certificate
  • Customer elects to use Self-Signed Virsae certificate
• Use Virsae CA Signed certificate
  • Customer elects to use Virsae's public DigiCert certificate
  • This certificate expires in July 2024
  • Requires Virsae Support to update the virtual collector with the appropriate certificate
• Use custom certificate
  • Customer elects to use their own preferred publicly signed certificate
  • Requires Virsae Support to update the virtual collector with the appropriate certificate

Once you have made your selection, Click 'Next' to continue.

Image Added

You will then be prompted to enter your Virtual Collector URL and the name of the profile group you setup earlier.

If you do not have a Virtual Collector URL, please contact your Virsae Service Delivery Manager or support@virsae.com 

Once these value have been entered click on the 'Check' button to confirm connectivity to the cloud.

Image Added

If connectivity is working correctly you will see a 'Successfully Connected' dialogue presented. If you are not successfully connected please double check the URL and Profile Group and check that you have internet connectivity open on port 443 to the Virtual Collector URL.

If your test was successful, click 'OK' then "Next' to continue.

Image Added

Confirm your installation by clicking the 'Install' button.

Image Added

Your installation will proceed, once complete click the 'Finish' button to close the installer.

Image Added

This completes installation of the VSM Everywhere clientAfter opening the command-line interface, use the Installation Commands section to create an installation string.

Install Via Microsoft Intune

...

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

Add A Win32 App

Anchor
AddWin32App AddWin32App

...

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

...

Use the following GUID for the uninstall command: {FCC97786-7AD7-49B0-98C2-131F864C6BA1} .

I.e. the uninstall command will be:

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

Include the version number provided in the MSI. This will help with support and updates. 

...

...

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".

...

You can omit the path to the installer MSI by changing the working directory in the command-line interface to where the installer is located.

To change directory in Command Prompt use :

msiexec /i 

VSM_Everywhere.msi

 /qn /norestart

/L*v "C:\

Windows\

Temp\

// 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.

...

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 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.

install.log" TARGETDIR="C:\Program Files\Virsae Group\Machine Proxy Agent E" CGWS="a356dhgj4g5j690f9e333a60da99x.VL-beta.virsae.io:443" GROUP="NZ/AUS"

Some additional parameters are available for setting Proxy Server and Certificate options. If these are omitted from the script then Proxy will be set to false, and communication will use the Virsae Self Signed Certificate.

Proxy Server Parameters:

• USE_PROXY=
  • "true"
    • Customer elects to use a proxy server
  • "false"
    • Customer elects to not use a proxy server
• PROXY_SERVER="FQDN_OR_IPADDRESS"
  • Input an IP Address or FQDN as the target proxy endpoint to connect to
• PROXY_PORT="PORT"
  • Input which port number on the target proxy server to communicate with

Certificate Parameters:

• CERT=
  • "SelfSigned"
    • Customer elects to use Self-Signed Virsae certificate
  • "VirsaeCA"
    • Customer elects to use Virsae's public DigiCert certificate
    • Requires updating the virtual collector with the appropriate certificate
  • "Custom"
    • Customer elects to use their own preferred publicly signed certificate
    • Requires updating the virtual collector with the appropriate certificate
• CERT_CN="CERTIFICATE_TARGET_HOST"
  • Can only be used when CERT="Custom"
  • Represents the Certificate Target Host to validate against

msiexec /i VSM_Everywhere.msi

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.

 /qn /norestart /L*v "C:\

Windows\

Temp\install.log" 

...

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.

TARGETDIR="C:\Program Files\Virsae Group\Machine Proxy Agent E" CGWS="

a356dhgj4g5j690f9e333a60da99x.

VL-beta.

virsae.

io:443" 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'

...

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.

Image Removed

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

Image Removed

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

Image Removed

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.

Image Removed

...

 CERT="Custom" CERT_CN="certificate.host.com" USE_PROXY="True"  PROXY_SERVER="192.168.10.89"  PROXY_PORT="3128"

Image Added

For "Step 4: Detection Rules", Manually configure a detection rule, selecting MSI and enter the version GUID above. Optionally use "File" detection and check for the folder "C:\Program Files\Virsae Group\Machine Proxy Agent E".

Image Added

Image Added

In Supersedence set the previous version you want upgraded by this version and ensure 'Uninstall previous version' is set to No.

Image Added

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".