Quick Start Guide 

29.01.2018 v2 
─ 

Nuage Networks   
755 Ravendale Drive 
Mountain View, CA 94043 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 1 

Overview 
This guide is designed to familiarize new users of the Nuage Networks eXperience (Nuage 
X) with the platform and how to use it to deploy a Nuage Networks VSP instance and 
complete some initial testing. The platform includes a documentation and knowledge base 
section for anyone looking to learn more about the Nuage Networks VSP SDN solution and 
the Nuage Networks VSP API. 
The Nuage Networks VSP comprises of three elements, the Nuage X lab will only include 
the Virtualized Services Directory (VSD) and the Virtualized Services Controller (VSC), with 
the user providing the host where the Virtualized Router & Switch (VRS) will be installed, 
which will connect workloads running on the host to the Nuage Networks overlay network.  
 

Goals 
1. Introduce the Nuage Networks eXperience (Nuage X) service 
2. Walk through all of the features available through the Nuage X platform 
3. Successfully deploy a Nuage Networks VSP instance 
4. Successfully connect a VM or bare metal host the Nuage Networks VSP instance 
5. Successfully deploy containers and VM based workloads on the new connected host 
6. Complete a basic testing that include API testing 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 2 

Requirements 
● Familiarity with Linux operating systems and Software Defined Networking (SDN) is 
not required, but desired 
● The platform does not deploy any hosts, therefore, the user must provide their own 
host (hypervisor in BM or VM). The host can be in a public cloud (AWS, GCE, Azure) 
or a BM service (Softlayer, packet.net) or in a private datacenter 
● Open access to the public IP address of the deployed lab (provided along with a 
deployed lab) and the following ports (TCP 8443, 6633, 7406 and 7509) 
 

⧫ ⧫ ⧫ 
 
   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 3 

Registration  
In order to use the platform, a user must first create an account at http://nuagex.io/signup, 
where they will need to fill-out the following form: 

 
An email will be automatically generated and sent to the e-mail address provided for 
confirmation, and once the user completes the confirmation process, the account will be 
sent for approval to the Nuage X admins. The approval process generally takes 24-48 hours 
to process.  

   
 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 4 

Login 
Once an account has been approved, the user will be immediately notified via e-mail and 
they will be able to login at http://nuagex.io/login using the username and password 
entered during the registration process 
 

   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 5 

User Dashboard 
The user dashboard is the first screen that user will see after logging into the platform. The 
dashboard has three key buttons, Jobs, Account Settings & Create Lab: 

1. Jobs 
This is the list of tasks that the user has initiated. A “0” means that all tasks 
requested by the user have been completed. Any pending task will show a “1” and a 
red circle until the task completes (as follows) 

 
 

   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 6 

2. Account Settings 
Users can edit their profile, change their password in the “account settings” icon 
along with providing feedback and/or requesting, support, or logging out. The 
“Help/Knowledge Base” button will redirect the user to our knowledge base 
(requires a separate sign-in process to zendesk). The “Contact Us” button can be 
used to reach our Nuage X support team (Please note, this is not the same team 
that handles your production environment. If you have an outage, please use your 
standard support contact procedure) 

 
If you choose to contact the Nuage X support team, you will need to submit the 
form below. Please include as much information as you think is needed to help our 
support team resolve your issue quickly. 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 7 

3. Create a new environment 

The button on the bottom right can be used to deploy a new Nuage Networks VSP 
instance 

 
 
Once clicked, the user will be shown a template window that will present the list of 
available labs/environments to deploy. As the user moves the cursor over the 
desired lab, a “Deploy” and “Details” buttons will appear. “Details” will show a 
diagram along with the description of the lab.   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 8 

Deploying Nuage Networks VSP Instances 

In order to deploy a Nuage Networks VSP instance, the user needs to specify a name and 
an expiration date. The Nuage Networks VSP instance will automatically get deleted upon 
expiration of the lab. You currently do not have the option to extend the lab, so for 
extended testing, please choose the appropriate expiration date (max is 30 days)  

 
 
   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 9 

After deploying a lab, the user will see an entry on the dashboard that represents a 
snapshot of the lab. The entry will include the hostname of the lab, the external IP address, 
the template used and the time left before the lab expires. 

 
When the user clicks on the “GET STARTED” button, she will see the detailed lab dashboard 
shown below with two main tabs, the “GET STARTED” tab, which includes a step by step 
guide to complete the setup of the environment and a “DOCUMENTATION” tab, which 
includes links to useful resources and user guides.  

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 10 

The “GET STARTED” tab consists of 5 sections that are summarized below: 

1. Environment Overview 
As the name implies, this is an overview of what the lab contains and what is 
expected to complete the setup. The user can click the “NEXT” button to move to the 
next step or on the section header itself. 

2. Nuage Networks VSD Access 

The Nuage Network VSD is the main management and configuration interface for 
the platform. The user’s unique credentials and the URL to access the VSD are listed 
in this section. The same credentials and URL can be used for interacting with the 
API.  

3. Nuage Networks VRS installation 

The deployed environment includes management and control elements of the 
platform and does not include any hosts for any workloads. The user is expected to 
have publicly accessible host(s). To complete the deployment of the platform, the 
user must install the Nuage Networks VRS her hosts. This section outlines some 
suggested options, with specific step-by-step instructions for each option. 
“Packet.net” is a bare metal service, “AWS” is another alternative and if the user has 
her own hosts or other hosted environments, she can use the “Generic” procedure. 
The “Packet.net” and “AWS” section are highly customized and include the 
deployment of the hosts themselves. The user can jump to the VRS installation step 
if they already have the hosts. More details on what takes place is explained in the 
next chapter of this guide. 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 11 

 
 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 12 

   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 13 

4. Deploy & Connect Virtual Machines 

Once the user has installed the VRS on her host(s) and the VRS successfully 
connected to the VSD/VSC instance on Nuage X, the setup is now ready to deploy 
test workloads (containers or VMs). The lab instance has sample application 
templates that include networking and security policies. We have created scripts to 
help the user get started and deploy Virtual Machines on these hosts with the 
required metadata to successfully connect to the overlay network. The user can just 
copy and paste these commands on her host(s).  

5. Deploy & Connect Containers 

To deploy containers, the users has a different set of commands to do so. A simple 
copy, paste and executing them on the hosts will deploy and containers with the 
right metadata to use properly attach to the overlay network. 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 14 

Connecting VRS to a VSP instance 

Since the user might be new to the Nuage Networks platform, it might be necessary to 
explain the “VRS” connectivity step. Once the deployed instance is marked “Green”, that 
means that it has been successfully deployed and is ready to have a VRS installed on a host 
and connected to it. The user may repeat this step on multiple hosts to connect them to 
her VSP instance. As mentioned before, the user must provide her own publicly accessible 
host. A Bare Metal server from packet.net or a VM (or bare metal) on AWS can used. Our 
automation scripts support Centos 7 and Ubuntu 14.04 but the platform supports a 
broader range of Operating Systems and versions. This is a limitation of the Nuage X 
platform scripts and not the product itself. 
After instantiating the host(s), the user can copy and paste the automatically generated 
commands on the host(s), then execute them. 
 
Sample 
 C
 ommand: 
 
curl ‑L ‑s  https://rebrand.ly/nuagex_vrs | bash ‑s 
500000000000000000000000.labs.nuagex.io d85ff9694f28daf5e424eb19099954404b57081a5eae7fca 

 
The above command will install all required dependencies, download and install the VRS 
before finally configuring the VRS to connect to the user’s lab. 
To manually check the status of the connection from the Nuage Networks VRS on the host 
to the Nuage Networks VSC in the VSP instance, the user can execute the following 
command and should see the output highlighted below: 
 
Command and sample output (is_connected must show true): 
 
[ 
root@usersHOST ]#
  ovs‑vsctl show  
     
Bridge 
 "
 alubr0" 
         
Controller   "
 ctrl1" 
            target  : " tcp:10.0.0.3:6633" 
            role : master 
            is_connected  : t
 rue 
         
Port  svc 
‑p at 
‑t ap 
 

   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 15 

VSP Administration & Management 

Managing the Nuage Networks VSP instance is done using the Nuage Networks VSD 
Architect at the https://<lab_ip>:8443 interface, with the URL and credentials provided 
within the lab dashboard view (right column - middle section) 

 
Once the user is logged into the VSD architect, the following dashboard will be displayed. 
There are two main areas to focus on in this view, the left side shows the tenants 
provisioned, and the top right are the main “admin” user configuration areas 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 16 

 
As “admin” user, the following four areas/actions are available: 

The Monitoring Console provides a 

Monitoring  complete view of the Nuage VSP 
Console     components apart from VSD, and their 
current operational state. 

All of the Nuage Networks Platform 

Platform 
configuration variables can be modified 
Configuration 
  using this view 

Logged in users can modify their profile 

User Preferences 
under user preferences 
 

Logout   To logout of the VSD architect view 

 

In order to view a particular tenant’s configuration dashboard, the user should choose the 
tenant from the left. They will then be able to view that tenants overlay network design. By 
default, the Dashboard/Topology view will be selected. For a more detailed view, the user 
must select the “Networks” tab highlighted in the capture below. 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 17 

In the Tenant’s “Networks” view, the user can view the Layer-2 and/or Layer-3 overlay 
networks available (templates and instances using these template). This quick start guide is 
not intended to work through all of the features, so for more details on how these features 
work, the Nuage Networks VSP User Guide is a better source and is included in as part of 
the deployed lab. 

   

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 18 

Connecting Sample Workloads 

The lab includes sample commands to deploy 3 containers or 3 virtual machines on the 
newly connected hosts. The scripts used include metadata that matches application 
templates created in advance on VSD. These are samples to help the user get started 
quickly. The user can modify them to add more workloads or make changes. 
Sample VM deployment commands: 

 
Sample Container deployment commands: 

Network & Security Policy Configuration 

For simplicity, the lab is deployed with relaxed network security rules that allow all traffic to 
flow between workloads in the same networks as well as on different networks in the same 
routed domain. However, this configuration is not desirable in a production environment 
and does not take advantage of the microsegmentation features built into the Nuage 
Networks VSP. This topic is described in great detail in the Nuage Networks VSP User Guide 
(Section: Security and Forwarding Policies), but we will provide an overview for new users. 
Here is where a user of Nuage X can find the “policy” section on the VSD GUI:  
 
 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 19 

[ Networks in the 1st Tier TAB > L3 Domains > Select L3 Domain Shared With Me > Then Choose 
“Policies” from the 2nd tier TAB] 

 
Below are some basic descriptions of the main topics that are relevant to network and 
security policies: 
Ingress Security Policies: Provides security policy for traffic from the Endpoint into 
the network. For Ingress security policies, the security policy is applied to the Source 
location (Endpoint) and the Remote Network is the Destination Network. 
Egress Security Policies: Provides security policy for traffic from the network to the 
Endpoint. For Egress security policies, the Location is the Destination Location, and 
the Remote Network is the Source Network. Typical usage for Egress security 
policies is to restrict traffic coming from outside the domain. For example, Internet 
traffic, traffic from an organization VPN. 
In order to modify security policies, the user must be in “Edit” mode (lock icon at the 
bottom) must be clicked to enter “Edit” mode. Once completed, the user must either 
discard or apply their changes, but clicking on the respective button on the top right of the 
screen.  

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 20 

Deleting a VSP Lab 

In order to delete a deployed lab, within the main labs dashboard view, clicking on the 
“DELETE” button will delete the lab. Another option is within the “Get Started” section of the 
specific lab by clicking on the bottom right “trash” icon. The user will be prompted to 
confirm the “delete” action (Note: This action cannot be undone) 

Documentation 
Along with the Nuage Networks VSP instance, the user will also be able to gain access to 
view or download the html version of the API programming guide, the Nuage Networks VSP 
installation guide as well as the user guide. 

Help 
For any issues with the Nuage X platform or a deployed instance, the user should send an 
email to nuagex+public@nuagenetworks.net 
 
 
 
 
 
 
 

 
Quick Start Guide Nuage Networks eXperience (Nuage X) | 21 

 
 
 
 
 
 
 
 
 
 
 

About Nuage Networks  

Nuage Networks (www.nuagenetworks.net) brings a unique combination of groundbreaking technologies and 
unmatched networking expertise to the enterprise and telecommunications industries. The Silicon Valley-based 
business has applied radically new thinking to the problem of delivering massively scalable and highly 
programmable SDN solutions within and across the datacenter and out to the wide area network with the security 
and availability required by business-critical environments. Nuage Networks, backed by the rapidly growing 
IP/Optical Networks business of Nokia, has the pedigree to serve the needs of the world’s biggest clouds. The cloud 
has made promises—the mission of Nuage Networks is to help you realize them. Discover more at 
www.nuagenetworks.net and follow us @nuagenetworks