ReSTNSX Quick Start Guide

Integrating ReSTNSX with VMware NSX-v and vCenter

First Published: 10/08/2017

This document provides step-by-step instructions and tips on the initial setup of the ReSTNSX virtual appliance.  If you require further assistance, please visit our blog or open a trouble ticket

The following procedure assume the ReSTNSX Appliance is deployed and powered on with a valid IP address that is accessible by HTTPS, port 443


Step 1: Access Virtual Appliance

Browse to the ReSTNSX Virtual Appliance via https://<ReSTNSX-IP> using Chrome. Firefox is in Feature Preview mode and is not currently supported.

On the login screen, enter the following credentials. Note that the password is case sensitive:

Username: admin

Password:  default

Step 2: Change Password and Set Banner (Optional)

Users and Passwords

Once logged in, the username and password may be changed to a complex password by navigating to Admin -> Users from the side menu.

Non-default passwords must be at least 8 characters and include one upper case letter, one lower case letter, one number, and one special character.

Additional users may also be added on this page.  Setting a user with non-Administrator privileges restricts them from adding or removing data sources to the system.


Login Banner

As an Administrator, a login banner may be set for all users accessing the system.  Enable the banner by clicking the slider to YES and enter a banner up to 255 characters.  The banner is enforced upon all subsequent logins for all users.

Screen Shot 2017-10-12 at 10.22.10 PM
Screen Shot 2017-10-12 at 10.22.36 PM

Step 3: Add NSX Manager as a Datasource


  • NSX-v Manager already deployed and configured with login credentials
  • HTTPS, port 443, open inbound to NSX Manager from the ReSTNSX Appliance IP

Navigate to Admin -> Datasources to add NSX Manager and vCenter pairs.  This step enables ReST NSX to access these resources over the ReST API for object and system configuration over HTTPS port 443.

Click + Add Data Source and complete the following steps:

  1. Select VMware NSX-v Manager from the drop-down menu
  2. Enter a Name.  The name is locally significant only and is an easy way to reference different NSX Managers that are defined as data sources
  3. Enter IP Address or Hostname of the NSX-v Manager
  4. Enter the Username for the Enterprise Admin or role with sufficient NSX Manager privileges
  5. Enter the Password for the Enterprise Admin or role with sufficient NSX Manager privileges
  6. Ensure Ignore Certificate Errors is selected
  7. Enable or Disable the slider button for this data source to be  active or not.  The active data source option provides Administrators to define the resources but not have them accessible for configuring and polling once added to the system.
  8. Click Add Datasource 

Note: If a Hostname is selected in Step 3, a valid DNS must have been entered during the appliance installation process


Step 3: Add vCenter as a Datasource


  • vCenter already deployed and configured with login credentials
  • HTTPS, port 443, open inbound to vCenter from the ReSTNSX Appliance IP
  • vCenter linked in NSX-v

To enable querying vCenter objects for association with NSX Manager policies, a vCenter must be added to ReSTNSX.  For NSX-v, you must add the vCenter that is already linked to the NSX Manager in the previous step as there is a 1:1 relationship of NSX-v Managers to vCenters.

Click + Add Data Source and repeat Step 2 but for vCenter and the associated credentials for the Enterprise Admin or role with sufficient privileges.



Step 4: Link Datasources

In this step, we will link the previously defined NSX-v and vCenter servers together in ReSTNSX.  By doing so, we are able to leverage the vCenter objects with NSX-v policies under ReSTNSX.

Single NSX Manager.  When only 1 NSX Manager and vCenter are defined, the Link button automatically link to them together

Multiple NSX Managers.  When multiple NSX Managers are defined, you must manually select the pairing by clicking the link button.  This will present a drop-down menu to select the pairing data source.

Note: The ReSTNSX appliance ships with a 45 day Evaluation License.  In this mode, users are limited to a single data source (NSX Manager) and the ability to create two Tenants only.






System Ready

After successfully completing these steps, your ReSTNSX Appliance is ready for use.   Click the ReSTNSX logo in the top left to return to the main dashboard to begin your configurations.