Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


CSO GUI Installer Overview


The CSO installer walks you through the steps needed to install and configure CSO onto your virtual machine (VM.) It provides features such as faster downloading and installation, auto-provisioning of the CSO virtual machines, and a UI for interaction and installation status. The installer can be run on the following operating systems:

  • Apple OS X and later.

  • Microsoft Windows 10 and later.

  • Ubuntu 14.04 and later.


Juniper Networks recommends using the CSO installer to install and configure CSO because of its ease-of-use and is less error-prone. You can, however, use the CLI if you prefer.

The overall flow for using the CSO installer is as follows:

  1. Download the CSO Downloader from the CSO Download page.
  2. Launch the CSO Downloader and click on Install.
  3. Log in using your Juniper Networks credentials.
  4. Enter setup information, such as hypervisor and the solution to install.
  5. Select your deployment size.
  6. Select location to download the CSO package, such as on the existing Installer VM (IVM) or on the host or on the local machine.
  7. Enter server credentials and the CSO Downloader downloads the required packages at the specified location.
  8. Click Next to set up the Installer UI.
  9. The CSO Downloader creates and deploys the necessary VMs.
  10. Once the installation is successful, the CSO Installer UI is automatically launched. If not, Click on CSO Installer GUI.

Use the CSO installer only for new installations. You cannot currently upgrade from a previously installed version using the CSO Downloader.

Upgrading from a previously installed version only downloads the CSO packages. It does not perform the actual upgrade. You must use the CLI to upgrade CSO. For more information, see Upgrading Contrail Service Orchestration Overview.

The CSO Downloader and Installer has two main components that perform the steps listed above:

  • Downloader—Downloads the CSO packages and creates an Installer Virtual Machine (IVM).

  • Installer—Creates the necessary VMs and installs the CSO packages.

About the Downloader Component

The downloader component of the CSO installer performs the following tasks:

  • Downloads the necessary CSO packages.

  • Creates an IVM.

  • Transfers the CSO packages to the IVM.

  • Launches the Installer component web-based user interface from the IVM.

The downloader component gives you the option to install now or to install later. The install now option performs all the tasks listed above. The install later option downloads the necessary packages but does not create the IVM or transfer the packages to the IVM.

For example, if you do not know the host machine IP address and root password, you might choose to download the necessary packages now and wait to create the IVM until you have that information.

Or, you might choose install later to download the necessary packages and use the CLI to install CSO.

About the Installer Component

The installer component of the CSO installer starts automatically after the downloader component finishes, and performs the following tasks:

  • Creates the required VMs.

  • Installs the CSO packages in the VMs.

When running the installer component, you select the following options in addition to configuring the VMs. Each option is described in detail in the installer user interface.

  • Size of the network to manage—small, medium, or large. The option you select determines the number of servers and the resource per server required. See Table 1.

    Table 1: Resources per Size




    Approximate number of managed sites




    High availability













    256 GB

    256 GB

    256 GB

    Disk space/server

    Greater than the summation of VMs which are deployed on the node.

  • Express install or Custom install. The express install uses pre-defined defaults and requires less user input. Select custom install if you want full control over the installation and configuration parameters.

  • Network type — CSO reachable directly or CSO behind a NAT gateway.

    CSO reachable directly means you can access the managed devices and CSO without going through a NAT gateway. Here, the CSO and devices IP’s are routable to each other within the enterprises private network. This topology is common in a campus environment where multiple locations are connected through VPNs as a single logical private network.

    For CSO behind a NAT gateway, the managed devices are typically remote devices not residing in the data center where CSO is installed. These devices reach CSO through a NAT gateway using a public IP address exposed for the data center. This topology is common when CSO manages customer’s remote or on-premises devices. For example, the branch locations of a bank or restaurant chain.