Discover and add storage systems using API endpoints

You can use API endpoints to discover and add storage systems to the managed list. This procedure creates a management connection between the storage system and the API.

Before you begin

About this task

This task describes how to discover and add storage systems using the REST API, so you can manage these systems in the interactive API documentation. However, you might want to manage storage systems in the Unified Manager instead, which provides an easy-to-use interface. For more information, see the online help available with Unified Manager.

Steps

  1. Discover storage systems, as follows:
    1. From the API documentation, make sure V2 is selected in the drop-down, and then expand the Storage-Systems category.
    2. Click the POST: /discovery endpoint, and then click Try it out.
    3. Enter the parameters as described in the table.

      startIP

      endIP

      Replace string with the starting and ending IP address range for one or more storage systems in the network.
      useAgents
      Set this value to either:
      • true = Use in-band agents for the network scan.
      • false = Do not use in-band agents for the network scan.
      connectionTimeout Enter the seconds allowed for the scan before the connection times out.
      maxPortsToUse Enter a maximum number of ports used for the network scan.
    4. Click Execute.
      Note: API actions execute without user prompts.
      The discovery process runs in the background.
    5. Make sure the code returns a 202.
    6. Under Response Body, locate the value returned for the requestId. You need the Request ID to view the results in the next step.
  2. View discovery results, as follows:
    1. Click the GET: /discovery endpoint, and then click Try it out.
    2. Enter the Request ID from the previous step. If you leave the Request ID blank, the endpoint defaults to the last request ID executed.
    3. Click Execute.
    4. Make sure the code returns 200.
    5. In the response body, locate your Request ID and the strings for storageSystems. The strings look similar to the following example:
      "storageSystems": [
          {
            "serialNumber": "123456789",
            "wwn": "000A011000AF0000000000001A0C000E",
            "label": "EF570_Array",
            "firmware": "08.41.10.01",
            "nvsram": "N5700-841834-001",
            "ipAddresses": [
              "10.xxx.xx.213",
              "10.xxx.xx.214"
            ],
      
    6. Write down the values for wwn, label, and ipAddresses. You need them for the next step.
  3. Add storage systems, as follows:
    1. Click the POST: /storage-system endpoint, and then click Try it out.
    2. Enter the parameters as described in the table.

      id

      Enter a unique name for this storage system. You can enter the label (displayed in the response for GET: /discovery), but the name can be any string you choose. If you do not provide a value for this field, Web Services automatically assigns a unique identifier.
      controllerAddresses

      Enter the IP addresses displayed in the response for GET: /discovery. For dual controllers, separate the IP addresses with a comma. For example:

      IP address 1”,”IP address 2

      validate Enter true, so you can receive confirmation that Web Services can connect to the storage system.
      password Enter the administrative password for the storage system.
      wwn Enter the WWN of the storage system (displayed in the response for GET: /discovery).
    3. Remove all strings after “enableTrace”: true, so that the entire string set is similar to the following example:
      {
        "id": "EF570_Array",
        "controllerAddresses": [
          "Controller-A-Mgmt-IP","Controller-B-Mgmt_IP"
        ],
        "validate":true,
        "password": "array-admin-password",
        "wwn": "000A011000AF0000000000001A0C000E",
        "enableTrace": true
      }
      
    4. Click Execute.
    5. Make sure the code response is 201, which indicates that the endpoint executed successfully.
      The Post: /storage-systems endpoint is queued. You can view the results using the GET: /storage-systems endpoint in the next step.
  4. Confirm the list addition, as follows:
    1. Click the GET: /storage-system endpoint.
      No parameters are required.
    2. Click Execute.
    3. Make sure that the code response is 200, which indicates that the endpoint executed successfully.
    4. In the response body, look for the storage system details. The returned values indicate that it was successfully added to the list of managed arrays, similar to the following example:
      [
        {
          "id": "EF570_Array",
          "name": "EF570_Array",
          "wwn": "000A011000AF0000000000001A0C000E",
          "passwordStatus": "valid",
          "passwordSet": true,
          "status": "optimal",
          "ip1": "10.xxx.xx.213",
          "ip2": "10.xxx.xx.214",
          "managementPaths": [
            "10.xxx.xx.213",
            "10.xxx.xx.214"
        ]
        }
      ]