For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.us.ovhcloud.com/en/hosted-private-cloud/vmware/enable-nsx-management-access-hosted-private-cloud-user-via-apis.md.
  • English

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

View as Markdown

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.

NSX - Enable NSX management access hosted private cloud user via apis - step 3

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.

NSX - Enable NSX management access hosted private cloud user via apis

 

Instructions

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

. Click the Execute button.

NSX - Enable NSX management access hosted private cloud user via apis - step 2

 

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

NSX - Enable NSX management access hosted private cloud user via apis - step 4

 

Scroll down and click on

.

  • 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.

NSX - Enable NSX management access hosted private cloud user via apis - step 5

 

Select

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.

NSX - Enable NSX management access hosted private cloud user via apis - step 6

 

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.

NSX - Enable NSX management access hosted private cloud user via apis - step 7

 

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

NSX - Enable NSX management access hosted private cloud user via apis - step 8

 

Go further

Browse all the VMware on OVHcloud guides.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about VMware on OVHcloud on the OVHcloud US website.