browse
Introduction
This article covers mass provisioning of the Umbrella roaming client or custom provisioning. To download and install the Umbrella roaming client on one machine, see our Umbrella Roaming Client Deployment guide.
The basic deployment option requires the OrgInfo.json file to be in the same folder as the Setup.msi file upon deployment. For deployment options that don't require this OrgInfo.json file, for deploying a hidden UI for the Umbrella roaming client, or deployment with RMM mass deployment tools, continue reading.
Setup files
This article will make reference to Setup.msi and RoamingClient_OSX***.pkg. These are the installlers for Windows and Mac, respectively. Information about mass deployment to OS X machines is at the bottom of this article.
There are two ways to obtain this file.
The easiest method is to download the latest installation from your client dashboard or our release notes and extract the setup file.
The second method that some MSPs may prefer to programmatically process the manifest file and append the filename provided in the manifest.
Deploying the Umbrella Roaming Client (Windows) with Parameters
The Umbrella roaming client installer (Setup.msi) can be configured with the required parameters to install without the OrgInfo.json file being located in the folder during deployment. This guide will contain sample values for these parameters that need to be replaced with unique values.
Parameters (Required)
- ORG_ID—Organization specific identifier
- ORG_FINGERPRINT—Unique code generated based on User_ID and Org_ID
- USER_ID—User specific identifier.
Note: This is not your login ID, it’s a seven-digit number located in your dashboard or in the OrgInfo.JSON file—see MSP sections below.
Additional Parameters (Optional)
|
Parameter |
Description |
Values |
|
HIDE_UI |
Hide the Umbrella roaming client tray icon from showing in the system tray / menu bar to decrease awareness/visibility to an end user. |
0 - show system tray icon (default) 1 - hide system tray icon |
|
HIDE_ARP |
Omit the Umbrella roaming client from the Add/Remove Program list in Windows to prevent trivial uninstallation by an Admin. |
0 - show in list (default) 1 - omit from list |
|
NO_AUTOSUFFIX |
Don’t add domains contained in the “DNS Suffixes” settings in network adapters and networking properties. This feature exists so that the Umbrella roaming client is more aware of local resources/domains on foreign networks. |
0 - add the domains (default) 1 - don’t add the domains |
|
NO_NXDOMAIN |
If a DNS query sent to Umbrella returns an NXDOMAIN, query the local DNS servers before giving up just in case. |
0 - query local DNS servers (default) 1 - don’t query local DNS servers |
Installing from the Command Prompt
The following command deploys the Umbrella roaming client silently (Admin privileges required!). If the deployment is not successful, we recommend installing the Umbrella roaming client once without the silent flag by removing the /qn flag from the following command to allow the error message to display.
msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111
Note:
For a hidden installation such as one without the GUI or Add/Remove Programs entry in Windows, scroll down to "Special Parameters"
Special Flags: Hiding the Roaming Client
There are a few extra parameters you can include in your deployment to tweak the Umbrella roaming client. To deploy the Umbrella roaming client without the User Interface, add the HIDE_UI=1 flag.
For example:
msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111 HIDE_UI=1
msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111 HIDE_UI=1 HIDE_ARP=1
Additional Resources:
In-depth documentation regarding the use of special flags for hiding the UI or the removal is available here. For Windows GPO provisioning, refer to our GPO guides for Windows Server 2008R2 and 2003.
Deploying the Umbrella Roaming Client (OS X)
For OS X, a hidden UI is the only supported install option. This must be completed within the OrgInfo.plist file that is included in the downloaded .zip file. The .pkg installer must be run from the same folder as the OrgInfo.plist file or there will be an error during installation. Refer to the Hiding the Umbrella Roaming Client UI document for more information. The OS X .plist file contains the same parameter information as the Windows version discussed here.
When deploying the OS X client to different customer organizations, the OrgInfo.json file can be extracted from the dashboard.
Extract the zip file from the download and in the extraction folder you should see two files:
- OrgInfo.plist—This is the information that identifies your roaming computers as part of your Organization
- RoamingClient_OSX***.pkg- This is the installer package
The .plist *must* be deployed to the endpoint computer alongside the metapackage. For more guidance, read here: