Skip to main content

How to Enable NSX Management Access for a Hosted Private Cloud User via APIs

Stephanie R.
Updated

When a new user is added to the Hosted Private Cloud environment with administrator rights (read/write access to all datacenters), NSX management access is not enabled by default, as shown below.

NSXaccessAPI01.PNG

This guide will show you how to use the API call to enable NSX management access.

To check the status of NSX management access for your user(s), log in to OVHcloud Control Panel.

  1. Select Hosted Private Cloud.
  2. Click VMware and select your environment.
  3. Click Users.
  4. Check the status for each user in the NSX Interface column.

NSXaccessAPI02.png

 

Instructions

To execute the API call, log in to OVHcloud API using your OVHcloud Control Panel credentials. Open /dedicatedCloud and select GET /dedicatedCloud. Click the Execute button.

NSXaccessAPI03.png

 

Copy the relevant environment from the response. An example is shown below.

NSXaccessAPI04.PNG

 

Scroll down and click on GET /dedicatedCloud/{serviceName}/user.

  • Enter the environment name from the previous step into the serviceName field.
  • Enter the name of the user (i.e., "admin") whose ID number you need.
  • Click on Execute button.
  • Copy the 5-digit user ID from the result.

NSXaccessAPI05.png

 

Select POST /dedicatedCloud/{serviceName}/user/{userId}/changeProperties and you can see that the serviceName is already mentioned.

  1. Enter the 5-digit user ID in the userId field.
  2. Select the rights checkboxes for canManageIpFailOvers, canManageNetwork, and nsxRight.
  3. Click on the Execute button.

NSXaccessAPI06.PNG

 

Wait for some time and you can see that the NSX management access has been granted to the user within the OVHcloud Control Panel, as shown below.

NSXaccessAPI07.PNG

 

The user can now log in to the NSX-T environment using the following credentials.

  • Username: <username>@pcc-XXX-XXX-XX-XX.ovh.us
  • Password: <same password used while creating the user>
  • URL: https://nsxt.pcc-XXX-XXX-XX-XX.ovh.us

NSXaccessAPI08.PNG

 

Go further

For more information and tutorials, please see our other Hosted Private Cloud support guides, our NSX guides, or the guides for other OVHcloud products and services.

Related articles