Congratulations on choosing CSO for Contrail SD-WAN, SD-LAN, Next Generation Firewall, and NFV lifecycle management. This guide is designed to help you quickly learn the basics of the Contrail Service Orchestration Customer Portal.
The Customer Portal helps you:
Add, manage, and maintain individual tenant sites in the service provider cloud and on-premises.
Monitor alerts, alarms, device events, security events, link-switch events, and more.
Manage existing CPE devices and software images.
Add, manage and maintain device policies and virtual network services.
Add security and SD-WAN reports.
Manage tenant-level and site-level users.
With these capabilities, you can add and manage all elements of CSO tenant sites and the devices dedicated to those sites. With RBAC control, sites and devices belonging to one tenant cannot be seen by other tenants or customers.
The following tasks describe administration-related functions that can be performed in the Customer Portal.
You can assign the following user types:
Tenant Operator—Able to view the list of users and certain details about them.
Tenant Administrator—Can add new tenant users as either an Operator or Administrator, and reset the password for existing users.
To add users:
The Add Tenant User page appears, as shown in Figure 1.
Figure 1: Add Tenant User Page
If you leave the user status as Enabled, an e-mail is sent from CSO to the user informing them that their account was created and giving them a Set your password link that they can click to set their own password on CSO. If the user is not enabled, it is shown as disabled in the list of users. A tenant administrator can later enable the user, at which time the Set your password e-mail is sent.
CSO uses Role-Based Access Control (RBAC) to isolate control of certain features to specific roles (groups of users). The following task describes how to add a custom role to your tenant.
The Roles page appears, as shown in Figure 2.
Figure 2: Roles Page
The Add Role page appears, as shown in Figure 3.
Figure 3: Add Role Page
Pay particular attention to the Access Privileges. There are six sections of access privileges:
Monitor
Resources
Configuration
Sites
Reports
Administration
All sections appear collapsed at first. You can expand the sections by clicking the > next to the desired section. This expands the capabilities within that section as shown in Figure 3. For more information regarding roles and their abilities, see Adding User-Defined Roles for Tenant Users.
A status message appears about the new role.
CSO automatically logs changes to an audit log. Tenant administrators can view, export, and purge audit logs based on date range.
To view or manage audit logs:
The Audit Logs page appears.
Audit log details are displayed on the right part of the page.
The export or purge audit logs window appears.
To upload a license:
The License Files page appears.
The Add License page appears, as shown in Figure 4.
Figure 4: Add License Page
(Optional) Add a description for this particular license file.
To push a license to a device:
The License Files page appears.
The Push License window appears, as shown in Figure 5.
Figure 5: Push License Window
This window shows all devices on which the license is already deployed. If it is not installed on any devices, an X is shown in the installed column.
A job status notification appears. Another notification will alert you when the job is complete.
A tenant administrator or operator can view the currently installed version of the IPS signature database by navigating to Administration > Signature Database. On the Signature Database page, the active database version appears. It shows the publish date, detector versions and a count of how many devices have this version installed.
A tenant administrator can install the Active Database onto devices:
The Install Signatures window appears.
A notification appears letting you know that the job is either starting now or scheduled for later.
Tenant operators and administrators can view a list of available SSL certificates by navigating to Administration > Certificate Management > Certificates. On the Certificates page is a list of the imported certificates. A tenant administrator can also install the imported certificates on CPE devices, uninstall certificates from devices, and view the sites at which certificates are installed. All of these capabilities are available by selecting the appropriate option from the More pull-down menu.
SSL certificates are used for SSL forward proxy.
CSO provides the ability to integrate Active Directory user identification for user-based firewall policy intents on SRX devices. To do this, CSO integrates with Juniper Identity Management System (JIMS). JIMS can be downloaded from within CSO by navigating to Administration > Identity Management and clicking the Download JIMS button.
Once downloaded and installed on a Microsoft Windows server, you can complete the JIMS to CSO configuration and the SRX-to-JIMS configuration by clicking the Proceed with Configuration button.
These configurations allow JIMS to provide Active Directory user identity information to SRX Series devices and to work in combination with CSO to allow the use of that information to create the firewall policy intents.
For more information, see Configuring CSO and JIMS Connection.
CSO provides integration with the Mist WiFi portal to allow administrators to manage Mist WiFi access points connected to EX Series switches at remote sites.
Tenant users in the Customer Portal can only view this setting while tenant administrators in the Customer Portal can change this setting.
To change the setting:
The slider turns blue.
Once completed, you can access the details about the access point by navigating to the Devices tab of the Resources > Site Management > Site Name page and click the access point name.
CSO provides two pre-defined security report definitions and one pre-defined SD-WAN report definition that are available at the Reports > Report Definitions > Security and Reports > Report Definitions > SD-WAN pages respectively.
Tenant users in the Customer Portal can only view the details of the report definitions.
Tenant administrators can run the reports by clicking the Run Now button. From the More pull-down menu, tenant administrators can also preview report definitions, send the reports by e-mail to a list of recipients, and so on. From the Add pull-down menu, tenant administrators can also add the following types of custom reports:
For Security Reports:
Log Report Definition
Bandwidth Report Definition
ANR Report Definition
For SD-WAN Reports:
Tenant Performance
Site Performance
Multiple instances of each report type can be added. New and cloned reports can have different contents and different schedules.
At the Reports > Generated Reports > Security and Reports > Generated Reports > SD-WAN pages, both tenant operators and tenant administrators can view the reports that have been generated. Administrators can also delete generated reports.
The following tasks describe the resource management functions that can be performed in the Customer Portal.
Note After adding a site, you can change the following settings:
Address and contact information
NTP server
Site information
Site capabilities
Provider Hub and Enterprise Hub configuration
On-Demand VPN threshold
Device templates
Device information
WAN links (such as IP addresses)
Advanced WAN settings (such as Internet breakout and backup)
Mesh tags
OAM overlays
LAN segments
Trunk ports
To allow for secure OAM communications between sites and CSO, each tenant must have at least one provider hub with OAM capabilities. Additional provider hubs can be added as needed; these additional hubs can be of type DATA_ONLY, OAM_ONLY, or OAM_AND_DATA. All of these shared hub devices are added to CSO by an administrator in the Administration Portal and assigned to a POP.
The procedure below describes adding a pre-provisioned provider hub site to your tenant.
To add a provider hub site:
The Add Provider Hub for Site Name page appears, as shown in Figure 6.
Figure 6: Add Provider Hub Page
Selecting a POP populates the Hub Device Name pull-down menu with the names of provider hub devices available in that POP.
Note If no devices are shown on the pull-down menu, contact your Juniper account manager or your OpCo administrator.
An add job message appears followed by a success or failure message for the device add job.
This task describes how to add an on-premises site. You can add two types of on-premises sites—On-Premises Spoke and Enterprise Hub. An on-premises spoke site can be added manually or with the use of a template that was previously added from the Resources > Templates > Site Templates page. This task can only be performed by a tenant administrator.
To add an on-premises spoke site:
The Sites page appears. Any sites that already exist are listed on this page.
The Add On-Premises Spoke Site for Tenant-Name page appears.
As shown in Figure 7, the summary page shows all of the configuration that was entered for the on-premises site.
Figure 7: Add On-Premises Spoke Summary Page
The status of the add operation is displayed.
The following task describes how to add an on-premises spoke site by using a previously-defined site template. This task can only be performed by a tenant administrator. If no templates are defined, CSO takes you to the Resources > Templates > Site Templates page to add a template before proceeding.
The Site page appears. Any sites that already exist are listed on this page.
The Add On-Premises Spoke Site page appears with large icons depicting the available templates, as shown in Figure 8.
Figure 8: Add On-Premises Spoke Site Page
The page changes and requests Site Data.
You can upload the site data from a JSON file or add the site data manually by filling in the fields that were left blank in the template.
The page changes to reveal site configuration information.
Site add job notifications appear as the job is started and when completed (success or failure).
The following task describes how to add a cloud spoke site. This task can only be performed by a tenant administrator.
Note Adding a cloud spoke site requires that you have an Amazon Web Services (AWS) virtual private cloud (VPC) in place with the following elements:
2 available elastic IP addresses in the AWS VPC.
4 available subnets in the AWS VPC.
The Sites page appears. Any sites that already exist are listed on this page.
The Add On-Premises Spoke Site for Tenant-Name window appears.
Note Fields marked with an asterisk (*) are mandatory and include configuration information regarding the AWS VPC.
For more information, see Adding Cloud Spoke Sites for SD-WAN Deployment and Provisioning a Cloud Spoke Site in AWS VPC.
The status of the add operation is displayed.
This task describes how to add an Enterprise Hub. This task can only be performed by a tenant administrator.
To add an Enterprise Hub:
Note You can add Enterprise Hub sites only for tenants with real-time optimized SD-WAN mode.
The Sites page appears. Any sites that already exist are listed on this page.
The Add Enterprise Hub for Tenant-Name page appears, as shown in Figure 9.
Figure 9: Add Enterprise Hub Page
Note Fields marked with an asterisk (*) are mandatory.
You are returned to the Sites page and a message indicating that the site creation job was triggered is displayed. You can click the job ID link to view the progress of the job. After the job is completed successfully, a confirmation message is displayed and the site that you added is displayed on the Sites page.
The Resources > Devices page shows a list of all spoke devices across all sites for your tenant. Tenant administrators and operators in CSO can see a list of all spoke devices. Tenant administrators can perform a number of operations on any one device by selecting the checkbox next to the device name and then selecting an operation from the More pull-down menu, as shown in Figure 10.
Figure 10: More Pull-down Menu on the Devices Page
If you click the device name link, you are taken to the OVERVIEW tab of the device details page for that particular device. On this page, you can see a lot of information about a device including:
Recent Alarms
Recent Alerts
Resource Utilization
Throughput
and more
The information on these charts can be adjusted to display over specific time periods.
The device details page also includes a CONFIGURATION TEMPLATE page which shows the configuration options managed by CSO through a variety of pre-made, stage-2 device templates. A tenant administrator can make changes to the available templates and then deploy them to the device. The administrator can also view a deployment history for the device.
You can deploy configuration templates as part of site onboarding or within a site template. You can also rollback a configuration template (which removes any configuration pushed to the device by the template) or undo the association (which leaves the configuration on the device but removes the template).
CSO provides tenant operators and administrators the ability to view device software images on the Resources > Images page. Tenant administrators can stage and deploy device images to CPE and hub devices by clicking the appropriate button. Tenant administrators can also see image upgrade history by clicking the appropriate button.
Staging device images prior to deployment is recommended for sites with slow links.
CSO allows tenant administrators to use the Site Groups page to view, create, and delete site groups for a tenant at Resources > Site Groups. Site groups enable you to group sites logically, thereby easing site management. You can use site groups to apply policies at the site group level.
CSO uses mesh tags to allow direct site-to-site communication (without a hub) using dynamic VPNs in SD-WAN environments. For this to happen, each site must have a matching mesh tag assigned.
Only tenant administrators have access to the Resources > Mesh Tags page at Resources > Mesh Tags. CSO ships with the pre-defined mesh tags, MPLS and INTERNET. These tags can not be deleted or modified. Administrators can add new tags for use in their network by clicking the Add icon (+) and filling out the information in the window that pops up.
CSO uses templates to allow for fast, repeatable site additions, to define device characteristics and capabilities, and to allow for expanded device configuration after a device is provisioned. CSO ships with a set of pre-defined device and configuration templates. These templates are available at Resources > Templates > Device Templates, and Resources > Templates > Configuration Templates, respectively.
Tenant operators can only view the available templates and their details, while tenant administrators can import new templates, clone existing templates, and edit cloned and unused templates. Templates that are already in use cannot be changed, but can be cloned.
The following procedure describes how to add a site template. Only tenant administrators can add site templates. Tenant operators can only view existing templates.
The Site Templates page appears.
The Add Site Template for Tenant Name appears and starts the process at the General tab.
Figure 11: Add Site Template Page
The page advances to WAN configuration form, as shown in Figure 12.
Figure 12: WAN Configuration Form
Required field names are marked with an asterisk (*). You must select at least one item from the Site Capabilities section.
If your tenant has LAN services available, the page advances to the LAN configuration form, as shown in Figure 13. If not, the LAN configuration section is automatically bypassed and the page advances to the Summary form.
Figure 13: LAN Configuration Form
The page advances to Summary.
Network Service deployment can only be performed by tenant administrators.
To deploy network services:
The Sites page appears.
Note The site must have an NFX Series device as a CPE so that network services can be deployed.
The Site-Name page appears.
The Deploy Network Services pane appears on the right side of the page.
The Deploy Network Service: Site-Name page appears.
The status of the deploy operation is displayed.
The status of the service is displayed.
The following tasks describe how to add, view, manage, and deploy policies. There are many types of policies and supporting shared objects. CSO keeps policy and profile management similar across the different policy types. Not all policies, profiles, or options are covered in the getting started panel.
Note You must be logged in as a tenant administrator to do anything other than view the various policies, profiles, and shared objects available on the configuration tab.
Intent-based firewall policies can control traffic in a number of ways:
Between security zones such as trust and untrust
Between departments such as marketing and accounting
Between specific addresses or address groups
Between sites or site groups belonging to the same tenant
Combinations of the above options
Additional options for the sources and destinations
To add an intent-based firewall policy:
Source endpoints can be IP addresses, IP address groups, sites, site groups, or departments.
Destination endpoints can be IP addresses, IP address groups, sites, site groups, departments, Layer 7 (L7) applications, or services.
The Firewall Policy page appears.
Best Practice In order for CSO to receive security monitoring data, we recommend that you enable Logging on all firewall policies.
The status of the save operation is displayed.
The Firewall Policy page appears.
The Deploy page appears.
The status of the deployment operation is displayed.
The Deployments page (Configuration > Deployments) displays the information about all deployments.
To create a NAT policy:
The NAT Policies page appears.
The Create NAT Policy page appears.
Note The Sites Applied On list only shows active sites for this tenant. You must activate at least one site in order to create a NAT policy.
Any site checked in the available list moves to the selected list.
The new policy now shows in the list of policies.
To view and manage a NAT policy:
Source endpoints can be IPv4 and IPv6 addresses, or port numbers.
Destination endpoints can be IPv4 and IPv6 addresses, or port numbers.
The NAT Policies page appears, displaying the existing NAT policies.
The Single NAT Policy page appears.
The status of the create operation is displayed.
The NAT Pools page appears.
The Create NAT Pool page displays fields required for creating and configuring a NAT pool.
The status of the create operation is displayed.
The NAT Policies page appears.
The NAT Policy Rules page appears.
Note Even though you select one or more NAT policy rules, when you click Deploy, all NAT policy rules that are associated with the NAT policy are deployed.
The status of the deployment operation is displayed.
To add and deploy an SD-WAN policy intent:
Source endpoints can be sites, site groups, or departments.
Destination endpoints can be applications or application groups.
The SD-WAN Policy page appears.
The status of the save operation is displayed.
The SD-WAN Policy page appears.
The Deploy page appears.
The status of the deployment operation is displayed.
The Deployments page (Configuration > Deployments) displays the information about all deployments.
To add a breakout profile:
The Breakout Profiles page appears.
Note You must have at least one Traffic Type Profile in the enabled state to complete the rest of this procedure. Traffic type profiles are managed by the SP administrator in the Administration Portal.
The Add Breakout Profile page appears.
Many of the policies and profiles under the Configuration tab use shared objects. To manage shared objects, navigate to Configuration > Shared Objects. The available types of shared objects are: Addresses, Departments, Services, and Application Signatures. All of these object types can be used in the creation of firewall intents.
CSO provides the ability to monitor the your sites, security events, link switch events, and more. The following list describes what can be seen using the CSO monitoring feature.
The map can be zoomed and filtered by site and/or alarm severity by selecting the appropriate checkbox from the Sites pull-down menu at the upper left corner of the map.
You can see the severity, time, tenant, site, and a description of the alerts, if any.
The OpCo or global administrator can create new alert definitions in the Administration Portal. Tenant operators and administrators can see the list and get details about each alert definition from the More menu.
The graph at the top of the page shows a count of alarms over a specified time period. You can adjust the time range for the graph to filter the alarms and create additional filters by tenant, site, source, and severity.
The graph at the top can be filtered to show only events within a certain time period. The list shows the SLA violation time, link switch time, Site, reason for the switch, and so on.
Firewall
Web Filtering
IPSec VPNs
Content Filtering
Antispam
Antivirus
IPS
Screen
Each type of security event view can be further filtered and customized on the individual page.
You can see a job history or see upcoming jobs that have been
scheduled for a future time.
Clicking on an individual Job Name shows the details about that job. Further details
may be available by clicking additional links within the job details
pop-up window.
CSO provides a dashboard, which is the default landing page upon successful login. The dashboard can display various graphical information about tenants and sites.
You can customize the dashboard by dragging widgets from the top carousel down to the main dashboard. Different users can have their own dashboards. A user can also have multiple dashboards defined.