English

View or edit existing controller assets

Contributors netapp-mwallis Download PDF of this page

You can view information about and edit existing VMware vCenter controllers in the management node configuration using the REST API. Controllers are VMware vCenter instances registered to the management node for your NetApp HCI installation.

Before you begin
  • Ensure that your cluster version is running NetApp Element software 11.3 or later.

  • Ensure that you have deployed a management node running version 11.3 or later.

Access the management services REST API

Steps
  1. Access the REST API UI for management services by entering the management node IP address followed by /vcenter/1/:

    https://[management node IP]/vcenter/1/
  2. Click Authorize or any lock icon and complete the following:

    1. Enter the cluster user name and password.

    2. Enter the client ID as mnode-client.

    3. Click Authorize to begin a session.

    4. Close the window.

View stored information about existing controllers

You can list existing vCenter controllers that are registered with the management node and view stored information about them using the REST API.

Steps
  1. Click GET /compute/controllers.

  2. Click Try it out.

  3. Click Execute.

    The API returns a list of all known vCenter controllers, along with the IP address, controller ID, hostname, and user ID used to communicate with each controller.

  4. If you want the connection status of a particular controller, copy the controller ID from the id field of that controller to your clipboard and see View the status of an existing controller.

View the status of an existing controller

You can view the status of any of the existing vCenter controllers registered with the management node. The API returns a status indicating whether NetApp Hybrid Cloud Control can connect with the vCenter controller as well as the reason for that status.

Steps
  1. Click GET /compute/controllers/{controller_id}/status.

  2. Click Try it out.

  3. Enter the controller ID you copied earlier in the controller_id parameter.

  4. Click Execute.

    The API returns a status of this particular vCenter controller, along with a reason for that status.

Edit the stored properties of a controller

You can edit the stored user name or password for any of the existing vCenter controllers registered with the management node. You cannot edit the stored IP address of an existing vCenter controller.

Steps
  1. Click PUT /compute/controllers/{controller_id}.

  2. Enter the controller ID of a vCenter controller in the controller_id parameter.

  3. Click Try it out.

  4. Change either of the following parameters in the Request body field:

    Parameter Type Description

    userId

    string

    Change the user ID used to communicate with the vCenter controller (the user must have administrator privileges).

    password

    string

    Change the password used to communicate with the vCenter controller.

  5. Click Execute.

    The API returns updated controller information.

Find more information