Skip to content
Last updated

HPE GreenLake for Storage Fleet Developer Guide

HPE GreenLake for Storage Fleet provides RESTful APIs to manage and configure storage systems and devices.

Prerequisites

Endpoints

Endpoints are the host URLs that you submit your API requests to. Storage Fleet has unique endpoints in specific regions. Use the following list to identify your application endpoint.

Authentication

The Object Storage API uses an access token for authentication. Instructions for obtaining an access token can be found on the Authentication page.

The HTTP Authorization request header is used to provide the access token in all API requests as a Bearer token.

  • Authorization:Bearer <access token>

Authorization

All API requests are authorized using permissions. The user owning the access token must have the required permissions assigned for the resources being accessed in order to be authorized. The required permissions are documented in the following guide pages.

Features

The Storage Fleet APIs are broadly categorized into the following feature areas:

  • Configure storage system settings such as system name and support contacts
  • Configure and manage storage system settings for security and encryption for data-at-rest
  • Manage storage system date and time settings
  • Configure system network and proxy settings
  • Report capacity and performance metrics with historical trends

Making it all work

General guidelines

  • For asynchronous operations that return HTTP status 201 or 202, use the Location header in the API response to track progress.

  • Replace the base URL in examples with the endpoint for your region.

Get all HPE Alletra Storage X10000 systems

Retrieves all systems available to your account in the specified region.

GET https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems

The endpoint https://us-west.api.greenlake.hpe.com is the endpoint for the US West application. If you are using HPE GreenLake for Storage Fleet in a different region, replace the endpoint with the endpoint the corresponding region.

Edit system settings

Updates configuration settings for a specific system.

PUT https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}

Payload:

{
  "auditPolicy": {
    "fwdThreshold": 4,
    "servers": [
      {
        "port": 1514,
        "protocol": "TCP",
        "target": "10.1.1.0"
      }
    ]
  },
  "autoSupport": "On",
  "clusterManagementDnsName": "usr1",
  "clusterManagementIpAddress": "10.0.0.11",
  "clusterManagementSubnetAddress": "255.255.255.0",
  "clusterManagementSubnetDefaultGateway": "255.255.255.1",
  "clusterName": "mip-01",
  "dnsServers": [
    "string"
  ],
  "force": true,
  "ntpServers": [
    "string"
  ],
  "outboundProxy": {
    "password": "ASCFJIUHGN7656NHIJF",
    "port": 3200,
    "server": "192.34.12.3",
    "username": "abcd"
  },
  "presentationTimeZone": "US/East-Indiana",
  "s3FrontEndConfiguration": {
    "s3DataNetworkConfigurations": [
      {
        "dataSubnet": "172.19.1.0/24",
        "dataSubnetGateway": "172.19.1.0",
        "s3IpRanges": [
          "172.19.3.50#44"
        ]
      }
    ],
    "s3DataNetworkDnsSubdomains": [
      "storage-dns-domain.com"
    ]
  },
  "supportContact": {
    "company": "HPE",
    "contactEmailAddress": "John@email.com",
    "country": "India",
    "firstName": "Jane",
    "lastName": "Joe",
    "phoneNumber": "5846624589",
    "preferredLanguage": "English"
  },
  "supportTunnel": "On"
}

Get all enclosures of a system

Lists all enclosures associated with the specified system.

GET https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/enclosures

Edit enclosure settings

Updates configuration for a specific enclosure.

PUT https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/enclosures/{enclosureId}

Payload:

{
  "locatorLedState": "On"
}

Get all storage nodes of a system

Retrieves storage nodes in the specified system.

GET https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/storage-nodes

Edit storage node

Updates configuration for a specific storage node.

PUT https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/storage-nodes/{nodeId}

Payload:

{
  "frontendNics": [
    {
      "ports": [
        {
          "mtu": 1600
        }
      ],
      "slotNumber": 1
    }
  ]
}

Get all switches of a system

Lists switches associated with the specified system.

GET https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/switches

Edit switch

Updates configuration for a specific switch.

PUT https://us-west.api.greenlake.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/{systemId}/switches/{switchId}

Payload:

{
  "internalNtpServer": "172.190.10.12",
  "locatorLedState": "On"
}
Previous page
Next page