Synergy Agent for Windows: Deployment Guide
Contents
Introduction
This document discusses the different methods to install the GV Agent file on a single machine and across multiple machines. Based on the requirement you can install the flavors for the agent. For Eg to apply for Seclore protection you need to install the seclore flavor agent, remaining all the steps are the same as mentioned below.
Basic Installation Method
Pre-requisites
The MSI file of the agent.
installerConfig.json file (optional)
Windows 10 machine
Admin access to install the agent
Steps
Download the MSI file to the Windows machine
Make sure all the office applications are not open to ensure the clean installation of the agent
Place the “installerConfig.json” file given by GV in the same place where the agent is present on the machine.
Edit the InstallerConfig file and edit the files based on the document below as per requirement:
Double click on the agent to proceed with the installation
Check the box to accept the terms in the License Agreement and click Install.
Click “Yes” to allow the app to change your device.
The installer will check if the Microsoft visual studio tools 2010 is installed and if not then the user will be prompted with the below dialog box to install it. Check the box and click on the button “install”
Press “finish”. The agent is installed now
Note: In case the machine doesn't have access to the internet then either the Microsoft website should be whitelisted or the executable file of the Visual Studio need to be brought inside to that machine. Here is the download link: https://www.microsoft.com/en-us/download/details.aspx?id=48217
Installation through CLI
Pre-requisites
The MSI file of the agent + installerConfig.json file.
Windows 10 machine
Admin access to install the agent
Steps
Open PowerShell as an Administrator and run the following command to install the Agent
Start-Process -Wait -ArgumentList "/qn" -PassThru -FilePath 'C:\Users\adm\Downloads\{path_to_msi}.msi' |
Where the “FilePath” argument contains the path of the file that needs to be installed.
Installation through group policy (GPO)
Pre-requisites
The MSI file of the agent.
Windows 10 machine
installerConfig.json file (optional)
Domain Admin level access to the Domain Controller
Steps
Create a folder and bring the agent file here.
Create a Network Share for the folder where the agent resides and assign access to the Domain Computers with the read level permissions. Now the MSI file will be available to all the Domain accounts.
Switch to our DC1 server and open the Group policy management console. Then expand Domains and then the domain in which you want to create the GPO.
Once you are in the correct domain, expand the Organizational Unit. Since we want the software to be installed on every single computer, we are going to create the Group Policy Object. Go ahead and click on that OU. To create a new GPO, right-click on the appropriate Organization Unit and select “Create a GPO in this domain, and Link it here”
Name your new GPO and hit OK.
Edit the new GPO: Select and then right-click on the GPO under the Organization Unit. Then select Edit.
Go ahead and expand Computer Configuration, then Policies, and then Software Settings.
Next click on and select Software Installation. Right-click on the right side of the Software Installation, select New and then click on Package.
Browse to the location where your software .msi file exists. Once you have located it, double click on the file or select it and then click on the “Open” button.
Select Assigned and click OK.
Don't forget to start updating the group policy object. To do this, open a command prompt on the domain controller and enter “gpupdate / force”
Once the update runs through you can go to one of your clients and restart the machine. Remember that for the software to be installed on a computer, you will need to do a hard reboot.
Installation through SCCM
Pre-requisites
SCCM Server
Access to the SCCM Server
GV Agent MSI file
Steps
Open SCCM and navigate to the Home tab and click on Applications. Then you need to create an application for the software to deploy
Create User Collection” to add a user group. In this progress, you need to set all the rules for deployment. From the Create User Collection Wizard browse and select the target distribution group. Here BPO users have been set as an example. Hit the “Next” button to finish the setting.
From the Deployment Settings, set the Action to install and the Purpose to Available. Click to check the box named “Require administrator approval if users request this application.” This will make the software available to the end user but will need administrator permission to install it. To finish the task, click on “Next”. The software in now deployed to the end user. Click on close to exit the program. You can check the details of deployment on the deployment completion page.
Arguments
The installer can accept additional arguments to adjust the installation process:
LAUNCHAGENT - determines if agent should be automatically started after installation. Allowed values = 0, 1. Default: 1
The arguments can be passed directly to the msiexec command, e.g: msiexec /i "path_to_msi.msi" LAUNCHAGENT=0
Config values - instead of using installerConfig.json (Agent - installerConfig.json and CLI config) to provide the config, it’s possible to inject them via CLI arguments (starting from version 4.0.0 of the agent):
SERVERADDRESS
SERVERUSESSL
LANGUAGE
VISUALSTYLE
KEYCLOAKCLIENTID
KEYCLOAKAUTHTYPE
KEYCLOAKUSERNAME
KEYCLOAKUSERPASSWORD
KEYCLOAKCLIENTSECRET
KEYCLOAKCERTIFICATECONTENT
KEYCLOAKKEYCONTENT
The arguments can be passed directly to the msiexec command, e.g: msiexec /i "path_to_msi.msi" SERVERADDRESS="{server_address}" SERVERUSESSL="True" LANGUAGE="en" VISUALSTYLE="1" KEYCLOAKCLIENTID="agent_v2" KEYCLOAKAUTHTYPE="1" KEYCLOAKUSERNAME="agent" KEYCLOAKUSERPASSWORD="{pwd}" KEYCLOAKCLIENTSECRET="{secret}"
GVClient.Tools.SetupHelper
can help generate the proper command:
References
MSI file installation through GPO:
https://community.spiceworks.com/how_to/160869-how-to-install-exe-with-group-policy
MSI file installation through SCCM: https://pdf.wondershare.com/business/how-to-deploy-software-with-sccm.html
Further installation steps
Classified as Getvisibility - Partner/Customer Confidential