Category filter

Script to set up Cisco Umbrella Roaming Client on Windows

Cisco Umbrella is a cloud-based security service that provides a wide range of security functions in a single platform. With the help of the Umbrella roaming client, enterprises can extend its protection to all users even outside the corporate network. Cisco Umbrella offers command-line installation of the roaming client on Windows devices and allows customization of the roaming client in terms of its appearance and behavior on the device. Performing a command-line installation on each and every device may not be feasible, especially if the organization has numerous endpoints. Using Hexnode’s Execute Custom Script action, you can remotely deploy the Cisco Umbrella roaming client on all your Windows endpoints effortlessly.

Disclaimer:

The Sample Scripts provided below are adapted from third-party Open-Source sites.

Deploying Cisco Roaming Client through Hexnode

The first step in the deployment process is to download the roaming client installation file from the Cisco Umbrella dashboard.

  1. Log in to Cisco Umbrella.
  2. Navigate to Deployments > Core Identities > Roaming Computers.
  3. Click on Roaming Client > Download.
  4. Choose Download Windows Client.
  5. Extract the downloaded .zip file.

The downloaded .zip file will contain OrgInfo.json and readme.txt file along with the Setup.msi file. You can host the Setup.msi file on a file server to be available for download on the Windows endpoints.

PowerShell script to install the Cisco Umbrella roaming client on an endpoint:

After specifying the file URL of the MSI package and the location on the endpoint to download the file, you can execute the script from the Hexnode console using the Execute Custom Script action.

You can invoke optional parameters along with the required parameters to configure the appearance and behavior of the roaming client on the Windows device. These parameters are appended along with the msiexec installation command.

Required parameters

The following three parameters should be mandatorily invoked in the installation command of the roaming client:

  • ORG_ID
  • FINGERPRINT_ID
  • USER_ID

The above values can be found from the OrgInfo.json file or the readme.txt file in the .zip file downloaded from the Cisco Umbrella dashboard.

Optional parameters

The following parameters can be optionally invoked if you want to change the appearance of the roaming client on the device or control the behavior of the client with regard to the internal domains configured in the Cisco Umbrella dashboard:

  • HIDE_UI: Hide the roaming client’s tray icon from the system tray of the Windows device to decrease awareness of the roaming client for the end-user.

    Values:

    0 – show system tray icon (default)

    1 – hide system tray icon

  • HIDE_ARP: Hide the roaming client from the Add/Remove Program list in Windows to prevent its removal by an end-user with admin rights.

    Values:

    0 – show in list (default)

    1 – omit from list

  • NO_AUTOSUFFIX: Don’t add domains present in the ‘DNS Suffixes’ settings in network adapters and networking properties to the Internal Domains list. This is to make the roaming client more aware of local resources/domains on foreign networks.

    Values:

    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.

    Values:

    0 – query local DNS servers (default)

    1 – don’t query local DNS servers

Notes:

  • To change parameters after installing the Umbrella roaming client, it must be uninstalled and reinstalled with new parameters.
  • It is recommended to manually validate the script execution on a system before executing the action in bulk.
  • Hexnode will not be responsible for any damage/loss to the system on the behavior of the script.
  • Sample Script Repository