The deployment-mssp Developer Hub

Welcome to the deployment-mssp developer hub. You'll find comprehensive guides and documentation to help you start working with deployment-mssp as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Automated Deployment

You can automate the deployment of the Umbrella roaming client through the use of remote monitoring and management (RMM) tools. This means that you do not manually download and install the Umbrella roaming client on each machine.


Sample RMM scripts are available that you can use to deploy the Cisco Umbrella roaming client to your customers’ client workstations. If your RMM is not listed, contact your Account Manager for assistance. The Umbrella roaming client software is only supported on client operating systems. Do not install the software on server-class operating systems.

We have prebuilt scripts for several RMM tools, which are available for download from our Deploy-Scripts GitHub page. We also have documentation for the following RMM tools:

The above documentation is specific to MSPs and as such procedures differ slightly for MSSPs. The successful use of an RMM tool requires deployment parameters that are unique to each customer's Umbrella dashboard. For MSSPs, deployment parameters are only available in the downloadable roaming client package, which is downloaded from the customer's Umbrella dashboard. Deployment parameters are not listed in the MSSP console.

Note: Periodically, we develop features, utilities, scripts, and other services that are not core to our product platform and roadmap, but may nonetheless help with your use of Umbrella. RMM deploy scripts are in this classification. We distribute these solutions freely because customers find them useful. Some of these solutions are not prioritized with our core products and, as such, are offered strictly as a convenience to our customers on an “as is” basis. In other words, we cannot guarantee their suitability for every customer nor that they will maintain their utility as our Umbrella platform and other third party software evolves over time.

The steps below are generic and may vary between RMM tools. Please see the links above for more information about each script. These steps assume that the example script has been imported to the RMM Tool.

  1. Log into your RMM tool.
  2. Find the Umbrella roaming client deploy script and run it for a small subset of representative computers before running it on all customer computers.

Acquire Deployment Parameters

Deployment parameters are available from the customer's Umbrella dashboard through the roaming client package, which includes a JSON file listing deployment parameters.

  1. In the MSSP console, navigate to Customer Management and click View Dashboard.
    The customer's Umbrella dashboard opens in a new browser tab.
  1. In Umbrella, navigate to Deployments > Core Identities > Roaming Computers and click Roaming Client.
  1. Click Download.
  1. In the downloaded package, locate the JSON file, and open it in a web browser.
    Deployment parameters are listed.

Note: The incorrect provisioning of devices will require that you uninstall and reinstall devices.

Distributed or Automated Installation with GPO or ARD

The distributed installation is best for mass deployment using deployments tools such as Group Policy Objects (GPO), Apple Remote Desktop (ARD), RMM tools, and other tools for automated software installations.

We have a detailed guide for deployments that utilize command line installations, which is what most software deployment tools will use.

We have specific guides for the most common software deployment tools:

Manual Deployment < Automated Deployment > Verify Roaming Client Operation

Updated 2 years ago

Automated Deployment

Suggested Edits are limited on API Reference Pages

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