This document contains details on how to deploy the Sync agent on a large scale using Microsoft System Center Configuration Manager.
Prerequisites
-
Firewall Rules:
-
Sync Portal: You will need to be able to access your Logitech Sync portal to download the provisioning package. The provisioning package is unique to each organization.
-
File Exceptions: Due to how Sync updates firmware, some anti-virus or Intrusion detection systems may block the installation or running of Sync.
Process Reason %ProgramFiles(x86)%\Logitech\LogiSync\
sync-agent\ LogiSyncMiddleware.exeResponsible for updating Firmware of Logitech Equipment. Sync will not manage or update the core operating system. LogiSyncInstaller.exe This is only used for the installation process.
Installer Process
- The LogiSyncInstaller.exe is a small stub installer. Its main purpose is to download and start the larger installer (LogiSyncAgent-Setup, ~60MB in size) from the Logitech Update Services.
- SCCM uses LogiSyncInstaller.exe (the stub installer) to download and install the application package. It does not report if the entire process has been completed. Please see the section below on Installation Verification for more details.
- It will take up to five minutes (based on internet speed) for the file to download and install. It takes an additional five minutes for the device to register in the Sync portal.
- A GUI front-end interface is not included with the bulk provisioning installer. Having the front-end tool is not required. Everything that needs to be accomplished with this can be completed from the portal. If you want the GUI tool, you can download that from the Logitech Sync Site and install it on the system. This is a supported configuration and the two products do work together.
Download the Sync Provisioning Package
- Login to your sync Portal.
- Click System > Import Room > Generate New Token.
- At the Token Window, choose for the token to never expire and for unlimited usages. If the token expires, you will need to update the SCCM package with a new token (and potentially a new installer), which could cause all systems to have the package re-installed. The reason for having the token expire is for a systems integrator to be able to install the Sync app on the company's behalf a certain number of times manually.
- Download the Windows Package.
- Copy the contents of the compressed file (both the LogiSyncInstaller.exe file and LogiSyncProvisionToken.json file) into the Logitech_sync folder (as defined by the SCCM Package).
Prepare the SCCM Directory
- Locate your SCCM distribution point. This is typically \\servername\sms_site.
- Create a directory LogitechProvisioning_Windows.
- Copy the two files from the Sync portal to that directory.
Install the SCCM Package
- Copy the compressed zip file to a network share.
- In SCCM go to applications/applications management and Import Application.
- In File Content, choose Create New.
- Once the import is complete, get the properties for the new application: Sync Provisioning.
- Make Changes to Owners and Support contacts as needed.
- Go to the Deployment Types and Edit Start Sync Stub.
- Under Content location, change the location to your configuration. For example\\svc-sccm-1\sms_site\SyncProvisioning_Windows.
- Apply the changes to the Application Package.
- Deploy the Package to a Collection.
Deploy the Package
- Build a Collection of the room systems you want to deploy to.
- Deploy the Application to a Collection.
- Make the application as Required.
- In User Notifications choose to hide all notifications.
If you make any changes to the Stub File you'll need to update content under Deployment types.
Installation Verification
To verify that the system was provisioned correctly, you can check the following:
- Does the device exist in the Sync Portal?
- File: Check in "C:\Windows\Temp\LogiSync\Sync-agent-installer.log" for the statement: .onInstSuccess - Exit code: 0 (note the . before onInstSuccess)
- Check for the following services:
- LogiSyncHandler
- LogiSyncLogger
- LogiSyncMiddleware
- LogiSyncProxy
Troubleshooting
Log files are located in the following locations:
- Services are started but no connection to Sync Portal
- Check to make sure the token downloaded has not been expired. The only way to test this is to check the website and see if a new token has been distributed.
- Ensure proper firewall ports are open
Uninstall
- There is no entry in Add/Remove Programs. To Uninstall Sync run the following command: “%ProgramFiles(x86)%\Logitech\LogiSync\sync-agent\uninst-agent.exe"
- Log into the Sync Portal. Once the computer shows error (meaning no longer connected to Sync), delete it by checking the box next to the name and then the delete button.
- If you are going to re-install you will need to reboot the system.
Installing the GUI application
The process to install the GUI application is very similar to the stub installer. It is recommended to install the stub version before the GUI application.
- Create a folder in your SCCM Distribution point called Sync.
- Download the SCCM Application compressed file and save it to a UNC location accessible by SCCM.
- Download Sync from Logitech Downloads. Place that installer (no need to change the name) into the folder above.
- In the Properties, make the following change in the Deployment Types:
- Change the Installation Program to the same name as the downloaded version from Sync. Do not remove /S
- Change the Content Location to the UNC location of the downloaded installer.
- Deploy the Application.
IMPORTANT: Uninstalling the GUI may not uninstall the existing Sync Application. You may need to run the uninstaller or delete folders/files manually.
Installing with Scheduled Tasks
If you don't have SCCM you can use Windows Scheduled Tasks to install. Once you create the task on one computer, you can export it and import into a different one.
The installer (the two downloaded files from Provisioning Packages) can be placed in a local folder, UNC or DFS file share location.
Important: In order to use Scheduled Tasks you'll need to enable the following firewall exceptions on the remote computer: Remote Scheduled Tasks Management (this is not set by default).
In this example, we are going to run the installer from a DFS file share
- Create a new Scheduled Task.
- In the general settings:
- Name the task Install Sync.
- Run the task with an account that is a local administrator of the computer and has access to the DFS file share. This must be an actual user account, local or domain, you cannot use networkService.
- Uncheck the box to not store the password.
- Select the option to run with Highest Privileges.
- Under Triggers assign it a time or other trigger to run, for example a specific time of day
- Under Actions create two actions
- Start a program (to uninstall old Sync software). This script can be found in the Uninstall section.: "\\vclab.test.com\Public\Software\SyncProvisioning_Windows\uninstall.cmd"
- Start a program (to install new Sync software): "\\vclab.test.com\Public\Software\SyncProvisioning_Windows\LogiSyncInstaller.exe" with an argument of --p (no need to enter any characters after the --p)
It will take several minutes for the new system to show in Sync, up to 15.
You can then export the task as an XML file then import it onto a new system. For details on importing a scheduled task, see this example.
Schtasks /Create /S RM201 /RU domain\user /RP M1Passw0rd /XMLFile c:\temp\InstallSync.xml /tn InstallSync
If you put all your rooms into a text file you can do the following:
- Create a text file with all your room names, one on each line. Just the room names, no header and no blank lines at the end.
- Create a CMD file with the following line:
for /F %%A in (c:\temp\rooms.txt) do schtasks /create /s %%A /RU domain\user /RP M1Passw0rd! /TN "Install Sync" /XML c:\temp\installSync.xml
To manually run the scheduled task on the computers in the list create a CMD file with the following:
for /F %%A in (c:\temp\rooms.tx) do schtasks /run /s %%A /TN "Install Sync".
Uninstalling
To uninstall both the front-end GUI version and the headless portal version, create a cmd file with the following lines:
"C:\Program Files (x86)\Logitech\LogiSync\sync-agent\uninst-agent.exe" /S
"C:\Program Files (x86)\Logitech\LogiSync\uninst-main.exe" /S
Timeout 60
rmdir /S /Q "%ProgramFiles(x86)%\Logitech\LogiSync"
rmdir /S /Q "C:\Windows\Temp\LogiSync"
rmdir /S /Q "%temp%\LogiSync"
rmdir /S /Q "%localappdata%\Logitech"
The command should be run under the same user that installed applications. The lines after the timeout are just cleanup details so if they do not run, don’t worry, the applications are still removed.
Frequently Asked Questions
There are no products available for this section