The Umbrella Documentation Hub

Welcome to the Umbrella documentation hub. Here you'll find access to all of our Cisco Umbrella user guides.

Get Started    

Appendix G – 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.

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.

Required Parameters (Windows)

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, and/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 (Windows)

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.

Parameter
Description
Values

HIDE_UI

Hide the Umbrella roaming client’s tray icon from showing in the system tray / menu bar to decrease awareness/visibility for 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 a user with local admin privileges.

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 to the Internal Domains list.

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

Optional Parameters (macOS)

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.

Parameter
Description
Values

InstallMenubar

Hide the Umbrella roaming client’s tray icon from showing in the system tray / menu bar to decrease awareness/visibility for an end-user.

False - Hide menu bar

True - Install menu bar (default)

NoNxDomain

If a DNS query sent to Umbrella returns an NXDOMAIN, query the local DNS servers before giving up just in case.

False - Query local DNS servers (default)

True - Don’t query local DNS servers

NoAutoSuffix

Don’t add domains contained in the “DNS Suffixes” settings in network adapters and networking properties to the Internal Domains list.
This feature exists so that the Umbrella roaming client is more aware of local resources/domains on foreign networks.

False - Add the domains (default)

True - Don’t add the domains

Deploying 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/"
  1. 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/"
  1. 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.


Appendix F – Encryption and Authentication < Appendix G – Command-Line and Customization for Installation> Appendix H – Remote Logging and Diagnostics

Updated 10 months ago


Appendix G – Command-Line and Customization for Installation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.