Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • A Virsae Cloud Collector and the URL and Port for this collector
  • A copy of the VSM-E silent 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 VSM-E installer package.

...

FieldDescription
Group NameThe name of the profile group.
Set As Default GroupIf 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 Enable

whereEnables the Performance Counter probe. If this option is not selected, you cannot

select the "Disk", "Memory", "Process", and "Processor" options.

DiskTracks the disk usage of a system.
MemoryTracks the memory usage of a system.
ProcessTracks the running process on the host system.
ProcessorTracks the CPU usage of a system.
Speed Test Probe EnableEnables the Speed Test Probe, which measures internet performance from the host

...

A collector MUST have a default group.

...


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

...

Note

A collector MUST have a default group.

When you create your first group, it will automatically be set as the default.

When the existing As such, when a default group is deleted and another group is available, it will be set as the default automatically.

...

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.

...

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.

...

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.

...

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.

...

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

I.e. the uninstall command will be:

Code Block
languageyml
 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.

Note

Logs will only be available if installations have FAILED.

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

...

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

Code Block
languageyml
// 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' 

...

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 :

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

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

Installation Commands
Anchor
Installation Commands
Installation Commands

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

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.

Code Block
languageyml
// 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'

...

The CGWS argument is used to specify the URL and port that the VSM-E client will communicate to your VSM Cloud Collector.

Please contact support@virsae.com for the URL and Port to use in this argument. in this example it is a356dhgj4g5j690f9e333a60da991.vl-beta.virsae.io:443

Code Block
languageyml
// 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" 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'

...

The GROUP argument takes the group name of a VSM-E Profile 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 Profile Group will be used instead.  and the VSM Everywhere profile group is 'NZ/AUS'  

Code Block
languageyml
// 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
languageyml
// 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.

Warning

Upgrades should only be performed via installing over the existing client.

Uninstalling and re-installing the client with the latest installer will cause data loss.


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
Anchor
AddWin32App
AddWin32App

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.

Note

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

I.e. the uninstall command will be:

Code Block
languageyml
 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.

Note

Logs will only be available if installations have FAILED.

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