Skip to main content
Element Software
A newer release of this product is available.

Create and manage storage cluster assets

Contributors netapp-pcarriga
PDFs

You can add new storage cluster assets to the management node, edit the stored credentials for known storage cluster assets, and delete storage cluster assets from the management node using the REST API.

What you'll need

  • Ensure that your storage 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.

Storage cluster asset management options

Choose one of the following options:

Retrieve the installation ID and cluster ID of a storage cluster asset

You can use the REST API get the installation ID and the ID of the storage cluster. You need the installation ID to add a new storage cluster asset, and the cluster ID to modify or delete a specific storage cluster asset.

Steps

  1. Access the REST API UI for the inventory service by entering the management node IP address followed by /inventory/1/:

    https://<ManagementNodeIP>/inventory/1/

  2. Select 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. Select Authorize to begin a session.

    4. Close the window.

  3. Select GET /installations.

  4. Select Try it out.

  5. Select Execute.

    The API returns a list of all known installations.

  6. From the code 200 response body, save the value in the id field, which you can find in the list of installations. This is the installation ID. For example:

    "installations": [
    {
      "id": "1234a678-12ab-35dc-7b4a-1234a5b6a7ba",
      "name": "my-sf-installation",
      "_links": {
        "collection": "https://localhost/inventory/1/installations",
        "self": "https://localhost/inventory/1/installations/1234a678-12ab-35dc-7b4a-1234a5b6a7ba"
      }
    }
  ]

  7. Access the REST API UI for the storage service by entering the management node IP address followed by /storage/1/:

    https://<ManagementNodeIP>/storage/1/

  8. Select 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. Select Authorize to begin a session.

    4. Close the window.

  9. Select GET /clusters.

  10. Select Try it out.

  11. Enter the installation ID you saved earlier into the installationId parameter.

  12. Select Execute.

    The API returns a list of all known storage clusters in this installation.

  13. From the code 200 response body, find the correct storage cluster and save the value in the cluster's storageId field. This is the storage cluster ID.

Add a new storage cluster asset

You can use the REST API to add one or more new storage cluster assets to the management node inventory. When you add a new storage cluster asset, it is automatically registered with the management node.

What you'll need

  • You have copied the storage cluster ID and installation ID for any storage clusters you want to add.

  • If you are adding more than one storage node, you have read and understood the limitations of the Authoritative cluster and multiple storage cluster support.

    Note All users defined on the authoritative cluster are defined as users on all other clusters tied to the NetApp Hybrid Cloud Control instance.
Steps

  1. Access the REST API UI for the storage service by entering the management node IP address followed by /storage/1/:

    https://<ManagementNodeIP>/storage/1/

  2. Select 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. Select Authorize to begin a session.

    4. Close the window.

  3. Select POST /clusters.

  4. Select Try it out.

  5. Enter the new storage cluster's information in the following parameters in the Request body field:

    {
  "installationId": "a1b2c34d-e56f-1a2b-c123-1ab2cd345d6e",
  "mvip": "10.0.0.1",
  "password": "admin",
  "userId": "admin"
}
    Parameter Type Description

    installationId

    string

    The installation in which to add the new storage cluster. Enter the installation ID you saved earlier into this parameter.

    mvip

    string

    The IPv4 management virtual IP address (MVIP) of the storage cluster.

    password

    string

    The password used to communicate with the storage cluster.

    userId

    string

    The user ID used to communicate with the storage cluster (the user must have administrator privileges).

  6. Select Execute.

    The API returns an object containing information about the newly added storage cluster asset, such as the name, version, and IP address information.

Edit the stored credentials for a storage cluster asset

You can edit the stored credentials that the management node uses to log in to a storage cluster. The user you choose must have cluster admin access.

Note Ensure you have followed the steps in Retrieve the installation ID and cluster ID of a storage cluster asset before continuing.
Steps

  1. Access the REST API UI for the storage service by entering the management node IP address followed by /storage/1/:

    https://<ManagementNodeIP>/storage/1/

  2. Select 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. Select Authorize to begin a session.

    4. Close the window.

  3. Select PUT /clusters/{storageId}.

  4. Select Try it out.

  5. Paste the storage cluster ID you copied earlier into the storageId parameter.

  6. Change one or both of the following parameters in the Request body field:

    {
  "password": "adminadmin",
  "userId": "admin"
}
    Parameter Type Description

    password

    string

    The password used to communicate with the storage cluster.

    userId

    string

    The user ID used to communicate with the storage cluster (the user must have administrator privileges).

  7. Select Execute.

Delete a storage cluster asset

You can delete a storage cluster asset if the storage cluster is no longer in service. When you remove a storage cluster asset, it is automatically unregistered from the management node.

Note Ensure you have followed the steps in Retrieve the installation ID and cluster ID of a storage cluster asset before continuing.
Steps

  1. Access the REST API UI for the storage service by entering the management node IP address followed by /storage/1/:

    https://<ManagementNodeIP>/storage/1/

  2. Select 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. Select Authorize to begin a session.

    4. Close the window.

  3. Select DELETE /clusters/{storageId}.

  4. Select Try it out.

  5. Enter the storage cluster ID you copied earlier in the storageId parameter.

  6. Select Execute.

    Upon success, the API returns an empty response.

Find more information