...
- A Virsae Cloud Collector and the URL and Port 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.
- A copy of the VSM-E installer
- A VSM Everywhere profile group configured in the web portal
- Administrator-level permissions on the machine where the VSM-E client will be installed.
...
Once a VSM Cloud Collector has been administered please contact support@virsae.com to request the URL and Port for this collector.
Getting the Installer
Contact support@virsae.com for a copy of the The VSM-E installer package.
...
is available in 'Service Desk> Files and Folders' - Then navigate to 'Shared with me> Virsae> VSM>VSM Software> VSM-Everywhere'
System Requirements
Item | Specification |
---|---|
CPU | Recommended 4 cores @ 2.4ghz |
RAM | 4GB |
Disk | 10GB |
O/S | Windows10 or above with .NET Framework 4.72 or higher |
Configuring Profile Group for VSM Everywhere
Before a VSM-E client can start tracking the performance of a system, it must first know what what metrics it needs to track. This is determined by creating a VSM-E Profile groupGroup.
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 ( of Service Desk > Equipment Locations):
Business Partner view (of from Customer tile > Service Desk > Equipment Locations):
Select VSM Everywhere (From from the required Equipment LocationsLocation):
Once you reach When on the Profile Groups page for the first time, you will see the following.
A profile group represents a set of metrics that the VSM-E client will track."No Profile Groups Found"
- To configure a profile group, click the "+" button at the bottom of the group list to begin
...
- creating a new group
...
- Enter a
...
- Group Name and
- Choose which metrics you wish to track
...
- by selecting Enabled and then the desired metrics
- Once complete click the 'Add Group' button
A Profile Group represents a set of metrics that the VSM-E client will track:
The table below describes what each option represents.
Field | Description |
---|---|
Group Name | The name of the profile group. (Note this cannot contain spaces) |
Set As Default Group | If a collector cannot find a group that is requested by a VSM Everywhere client, this is the group that will be used. |
Performance Counter Probe EnableEnabled | whereEnables Enables the Performance Counter probe. If this option is not selected, you cannot select the "Disk", "Memory", "Process", and "Processor" options. |
Disk | Tracks the disk usage of a system. |
Memory | Tracks the memory usage of a system. |
Process | Tracks the running process on the host system. |
Processor | Tracks the CPU usage of a system. |
Speed Test Probe Enable | Enables the Speed Test Probe, which measures internet performance from the host. |
Speed Test Frequency | Select a recurring frequency between 5 minutes and 60 minutes. (Default value is 10 minutes) This requires a VSM-E version of 1.0.53 and above. |
The Default groups group will have a tick beside their the name in the side navigation bar.
...
Installing VSM Everywhere
After everything has been set up, to install VSM-E, 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 manually or Intune to automate installs.
Manual Installation
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
The command line and powershell arguments below contain the placeholders {VIRSAE CLOUD COLLECTOR URL:PORT} and {PROFILE_GROUP}, replace these respectively with your Cloud Collector URL and Port, and Profile Group name.
The path to the *.msi file and the install.log will need to be altered to suit the location of your installation files.
If VSM Everywhere is installed with no group name, or if the collector could not find the requested group, the default Profile Group will be used instead.
Code Block | ||
---|---|---|
| ||
// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\install.log" CGWS="{VIRSAE CLOUD COLLECTOR URL:PORT}" GROUP="{PROFILE_GROUP}"
//Powershell
> Start-Process msiexec.exe -Wait -ArgumentList '/i C:\Path\To\MachineProxyAgentE_Installer.msi /qn /norestart /L*v C:\path\to\install.log CGWS={VIRSAE CLOUD COLLECTOR URL:PORT} GROUP={PROFILE_GROUP}' |
The following example will perform a silent install of VSM-E with logging. The Virsae Cloud Collector URL and port are 'a356dhgj4g5j690f9e333a60da991.vl-beta.virsae.io:443' and the VSM Everywhere profile group is 'NZ/AUS'
Code Block | ||
---|---|---|
| ||
// Command Prompt
> msiexec /i "C:\Path\To\MachineProxyAgentE_Installer.msi" /qn /norestart /L*v "C:\path\to\install.log" CGWS="a356dhgj4g5j690f9e333a60da991.vl-beta.virsae.io:443" 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=a356dhgj4g5j690f9e333a60da991.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.
The path to the *.msi file and the uninstall.log will need to be altered to suit the location of your installation files.
Code Block | ||
---|---|---|
| ||
// 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' |
Upgrading VSM Everywhere
To upgrade, simply install over the VSM Everywhere Client by using the latest installer and the same installation commands that were used to install the client previously.
...
Upgrades should only be performed via installing over the existing client.
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.
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.
You will then be presented with the installer title page, click 'Next' to continue.
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.
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.
Next you will have the opportunity to enter proxy details if required, or continue without a proxy. Click 'Next' to continue.
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.
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.
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.
Confirm your installation by clicking the 'Install' button.
Your installation will proceed, once complete click the 'Finish' button to close the installer.
This completes installation of the VSM Everywhere client
...
.
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 AnchorAddWin32App AddWin32App
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. Include the version number provided in the MSI. This will help with support and updates.
Note | |||||
---|---|---|---|---|---|
| |||||
The following install command will install VSM Everywhere into 'C:\Program Files\Virsae Group\Machine Proxy Agent E' with the URL set to "a356dhgj4g5j690f9e333a60da99x.VL-beta.virsae.io" and the Group set to "NZ/AUS", please replace these values with those which are suitable for your installation.
|
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
- "true"
- 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
- "SelfSigned"
- CERT_CN="CERTIFICATE_TARGET_HOST"
- Can only be used when CERT="Custom"
- Represents the Certificate Target Host to validate against
Note | ||||||
---|---|---|---|---|---|---|
| ||||||
The following install command will install VSM Everywhere into 'C:\Program Files\Virsae Group\Machine Proxy Agent E' with the URL set to "a356dhgj4g5j690f9e333a60da99x.VL-beta.virsae.io" and the Group set to "NZ/AUS", Using a proxy server and a Custom Certificate please replace these values with those which are suitable for your installation. Use the following GUID for the uninstall command: {FCC97786-7AD7-49B0-98C2-131F864C6BA1} . I.e. the uninstall command will be:
|
For "Step 4: Detection Rules", use the Manually configure a detection rule, selecting MSI and enter the version GUID above. Optionally use "File" option detection and check for the folder "C:\Program Files\Virsae Group\Machine Proxy Agent E".
In Supersedence set the previous version you want upgraded by this version and ensure 'Uninstall previous version' is set to No.
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
...