Command-line and Customization for Installation

In order to install the Cisco Umbrella roaming client in different scenarios, Umbrella provides a number of custom parameters that can be applied in a command line to modify the installation. A command-line installation is the only way to customize Umbrella roaming client behavior and appearance, so this article appeals to both single/standalone installations, as well as widely distributed installations. This article discusses installations without the context of deployment tools for mass deployment.

The parameters you can tweak include hiding the graphical elements, hiding the program from being uninstalled, and modifying behavior in regard to Internal Domains.

Table of Contents

• Prerequisites and Instructions
• Parameters
  • Windows
  • macOS
• Deploy Through the Command Line
  • Windows
  • macOS

Prerequisites and Instructions

Firstly, start by downloading the Umbrella roaming client. Ensure you've met the prerequisites to install the Umbrella roaming client. Then, review and decide on desirable optional parameters for Windows and macOS, which modify the Umbrella roaming client's behavior and appearance. Lastly, deploy the Umbrella roaming client through the command line using required and optional parameters.

Parameters

Setting the parameters correctly from the beginning of installation is important. To change parameters after installing the Umbrella roaming client, it must be uninstalled and reinstalled with new parameters.

Windows

Required Parameters

In order to deploy the Umbrella roaming client, you need to utilize the following parameters:

• ORG_ID
• FINGERPRINT_ID
• USER_ID

They can be found in OrgInfo.json or in the example section of the readme.txt file, both of which can be found in the Umbrella roaming client .zip file downloaded from Umbrella.

Example Usage:

msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111

Optional Parameters

 
These optional parameters change the behavior or appearance of the Umbrella roaming client. These are applicable in the command line during installation only. No further parameters beyond the three above are supported inside the OrgInfo.json. 

macOS

Optional Parameters

 
These optional parameters change the behavior or appearance of the Umbrella roaming client. These options must be invoked by modifying the OrgInfo.plist file.

To make changes, open the OrgInfo.plist file, found in the Umbrella roaming client’s .zip file, and add the corresponding key and value. For example:

<plist version="1.0">
<dict>     
<key>APIFingerprint</key>
<string>ORG_FINGERPRINT</string>
 <key>APIOrganizationID</key>
 <string>ORG_ID</string>
<key>APIUserID</key>
<string>USER_ID</string>
<key>InstallMenubar</key>
<false/>
</dict>
</plist>

Changes cannot be made to an already installed roaming client. To change an installed client, you must first uninstall it, restart your computer and then reinstall the roaming client with an updated OrgInfo.plist file.

Deploy Through the Command Line

Windows

In order to install correctly, open an Administrative Command Prompt to guarantee sufficient permissions are granted to the installer.

At a minimum, all three required parameters must be provided to install through the command line. The /qn flags (Quiet, Non-interactive) are included here to ensure the installation does not appear to the end-user:

msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111

If optional parameters are desired, simply append them to the deployment command.

msiexec /i Setup.msi /qn ORG_ID=222222 ORG_FINGERPRINT=1234567890abcdef USER_ID=111111 HIDE_UI=1 HIDE_ARP=1

You should perform this on an individual machine to ensure it's working as expected before using a deployment tool to install this to a larger user base.

macOS

1. First, you must create a folder on the computer:

sudo mkdir "/Library/Application Support/OpenDNS Roaming Client/"

2. Then, copy the OrgInfo.plist file—found in the downloaded Roaming Client .zip file—to the new location.

sudo cp OrgInfo.plist "/Library/Application Support/OpenDNS Roaming Client/"

3. Use the installer utility to install the Umbrella roaming client to the local hard drive.  Replace "#.#.##" in the following command with the actual version number/filename:

sudo /usr/sbin/installer -pkg /path/to/RoamingClient_MAC_#.#.##.pkg  -target /

The command should yield the following results:

These commands can easily be put into a simple script, as long as the Umbrella roaming client .pkg and OrgInfo.plist files are in the same place on each computer.

Encryption and Authentication < Command-line and Customization for Installation > Remote Logging and Diagnostics