ReSTNSX Quick Start Guide

Integrating ReSTNSX 1.2(9)+ with VMware NSX-v and vCenter

First Published: 12/05/2017, Edited 9/19/2018

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

OVA Deployment

The ReSTNSX deployment is performed in vCenter using the Deploy OVF Template option.  During the Customize Template step, please note the following:

  • Multiple DNS entries to be separated by spaces
  • Hostname limited to 15 characters
  • Leave Network IP/Mask empty for DHCP


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


Required:

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

This step enables ReST NSX to access these resources over the ReST API for object and system configuration over HTTPS port 443. Upon logging into ReSTSX for the first time or when no Data Sources are detected, the following pop-up will appear to get started.

 

 

Alternatively, Navigate to Admin -> Datasources to add NSX Manager and vCenter pairs.

Click + Add Data Source and complete the following steps:

  1. Select VMware NSX-v Manager from the drop-down menu
  2. Enter a Display Name.  This name is locally significant only and is an easy way to reference different NSX Managers that are defined as data sources
  3. Enter a Group Name. This name is locally significant only and is an easy way to group different NSX Managers (Optional) 
  4. Enter IP Address or Hostname of the NSX-v Manager
  5. Enter the Username for the Enterprise Admin or role with sufficient NSX Manager privileges
  6. Enter the Password for the Enterprise Admin or role with sufficient NSX Manager privileges
  7. Ensure Ignore Certificate Errors is selected
  8. Click Next.  By clicking Next, ReSTSNX attempts to validate the credentials against NSX Manager while retrieving the vCenter IP address and username.

Note: If an invalid username or password is entered, you may proceed to the next step by clicking the Proceed with Errors checkbox

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

Required:

  • 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, ReSTNSX automatically detects the associated vCenter in the previous step.

  1. Enter the vCenter Password for the Enterprise Admin or role with sufficient NSX Manager privileges
  2. Select data source to be Active or Inactive.  Enable or Disable the slider button for this data source to be active or not. This option allows Administrators to define the resources for future use but not have them accessible for configuring and polling once added to the system.
  3. Click Next.  By clicking Next, ReSTSNX attempts to validate the credentials against vCenter if selected as an Active data source.

Note: If an invalid username or password is entered, you may proceed to the next step by clicking the Proceed with Errors checkbox

 


 

Step 4: Verify Connectivity


NSX and vCenter Data Sources are now visible to ReSTNSX

 


 

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.