Skip to content

HPE Greenlake For Storage Fleet REST APIs (1.4.0)

HPE Greenlake For Storage Fleet REST APIs

Download OpenAPI description
storage-fleet-api.json
storage-fleet-api.yaml
Overview
License
HPE End User License Agreement
Languages
Servers
https://eu1.data.cloud.hpe.com/
https://us1.data.cloud.hpe.com/
https://jp1.data.cloud.hpe.com/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/storage-fleet/public/openapi/storage-fleet-public-v1alpha1/storage-fleet-api/

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

encryption

The encryption API allows the actions on encryption.

Operations

jbofioms

The JBOF IOM API provides endpoints for managing and configuring JBOF IOMs.

Operations

migrations

The Migrations API allows the management of data migration from source storage systems.

Operations

Get all migration sources (partners) connected to HPE Alletra Storage MP B10000 system identified by {systemId}

Request

Get all migration sources (partners) connected to HPE Alletra Storage MP B10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
filterstring

oData query to filter migration sources by key.

Example: filter=systemId eq SGH001SVQ8
sortstring

oData query to sort migration sources by key.

Example: sort=name desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/migration-partners \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4MigrationSource)required
items[].​idstringrequired

Unique identifier of the resource Filter, Sort

Example: "2c9412f703442635dc11a6e2109ed784"
items[].​typestringrequired

Type of resource

Example: "Migration Source"
items[].​activeControllerstring or null

Indicates the active controller of the nimble array

Example: "A"
items[].​cacheExpiredboolean or null

Indicates if migration source cache is expired

Example: true
items[].​certFileNamestring or null

Migration source certificate file name

Example: "cert.pem"
items[].​configErrorstring or null

Migration source configuration error

Example: "config error"
items[].​connectionStateobject or null

Describes the state of migration source

items[].​customerIdstring or null

Customer ID

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​deviceFamilystring or null

Device family to which the migration source array belongs. It represents one of 3PAR, Nimble or HPE Alletra Storage MP family devices.

Example: "3PAR/PRIMERA/ALLETRA-9K"
items[].​displayNamestring or null(string)

Name to be used for display purposes

Example: "MIGRATION_ID_NAME"
items[].​domainstring or null

Domain name of the Migration Source

Example: "3par"
items[].​generationinteger or null(int64)

Generation Filter, Sort

Example: 1657176632
items[].​hostNamestring or null

The host name or IP address of the migration source system Filter

Example: "15.212.192.134"
items[].​hostSetsArray of objects or null or null(DeviceType4MigrationSourceHostSet)

The cached host sets of the migration source system

items[].​hostsArray of objects or null or null(DeviceType4MigrationSourceHost)

The cached hosts of the migration source system

items[].​lastModifiedEpochinteger or null(int64)

Gives the last modified time

Example: 1657176632
items[].​linkPairsArray of objects or null or null

The peer link pairs between the source and the target systems. Up to 4 peer link pairs are supported.

items[].​migrationCountobject or null

Gives status based migration count

items[].​modelstring or null

Migration source system model

Example: "HPE_3PAR 20840"
items[].​namestring or null

Migration source system name Filter, Sort

Example: "cs4-20840-YY0K"
items[].​osVersionobject or null(DeviceType4MigrationSourceOsVersion)
items[].​peerHostsArray of strings or null or null

Migration source peer hosts

items[].​phasestring or null

Migration source phase

Example: "phase"
items[].​poolsArray of objects or null or null(ArcusMigrationSourcePools)

cached pools of the migration source system

items[].​portsArray of objects or null or null(DeviceType4MigrationSourcePort)

The cached ports of the migration source system

items[].​protocolstring or null

The protocol to be used for migration. This is supported from OS version 10.5.0 onwards.

Enum"FC""iSCSI"null
Example: "FC"
items[].​rcGroupsArray of objects or null or null(DeviceType4MigrationSourceRCGroup)

The cached remote copy groups / replication sets of the migration source system

items[].​resourceUristring or null

Resource URI

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/SGH001SVQ8/migration-partners/881d76a146c10ec090fe76c0197df123"
items[].​selectedLinkPairobject or null

selected or preferred peer link pairs between the source and the target systems

items[].​selectedPoolobject or null

migration source pool

items[].​serverCertobject or null

Migration source certificate information

items[].​subnetsArray of objects or null or null(ArcusMigrationSourceSubnets)

cached subnets of the migration source system

items[].​systemIdstring or null

System UID Filter, Sort

Example: "SGH001SVQ8"
items[].​systemSerialstring or null

Migration source system serial number

Example: "SGH709YY0K"
items[].​systemWwnstring or null

System WWN

Example: "2FF70002AC01D32B"
items[].​userNamestring or null

Username to log into migration source system Filter, Sort

Example: "userName"
items[].​usingSmartSanboolean or null

Indicates if SmartSAN is used to create peer link zones

Example: true
items[].​vendorstring or null

Migration source vendor

Example: "HPE 3PAR"
items[].​verifyServerCertboolean or null

Indicates if migration source certificate needs to be verified

Example: true
items[].​volumeSetsArray of objects or null or null(DeviceType4MigrationSourceVolumeSet)

The cached volume or application sets of the migration source system

items[].​volumesArray of objects or null or null(DeviceType4MigrationSourceVolume)

The cached volumes of the migration source system

totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Add migration source (partner) system to HPE Alletra Storage MP B10000 system identified by {systemId}

Request

Add migration source (partner) system to HPE Alletra Storage MP B10000 system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
hostNamestringrequired

Hostname or IP of the migration partner system

Example: "migration.partner.com"
userNamestringrequired

Username to connect to the migration partner system

Example: "userName"
passwordArray of stringsrequired

Password to connect to the migration partner system

Example: ["p","a","s","s","w","o","r","d"]
deviceFamilystringrequired

Device family to which the migration source array belongs. Supported options

  • "3PAR/PRIMERA/ALLETRA-9K"
  • "NIMBLE/ALLETRA-5K/ALLETRA-6K"
  • "HPE-GREENLAKE-FOR-BLOCK-STORAGE" (Before OS version 10.6.0)
  • "HPE-ALLETRA-STORAGE-MP-B10000" (OS version 10.6.0 onwards)
Example: "3PAR/PRIMERA/ALLETRA-9K"
certificatestring

Server certificate of the migration partner system. Certificate is not required for HPE Alletra Storage MP B10000 system with OS version 10.3.0 or above.

Example: "-----BEGIN CERTIFICATE-----\nCertificate Content\n-----END CERTIFICATE-----"
poolNamestring

Pool name of the migration source from which the volumes need to be migrated. Applicable for nimble family migration source.

Example: "default"
protocolstring

The protocol to be used for migration. This is supported from OS version 10.5.0 onwards.

Enum"FC""iSCSI"
Example: "FC"
viewAcceptCertboolean or null

Indicates that the user wants to view and accept the certificate before connecting to the migration source. Applicable for nimble family migration source.

Example: true
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/migration-partners \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceFamily": "3PAR/PRIMERA/ALLETRA-9K",
    "hostName": "migration.partner.com",
    "password": [
      "p",
      "a",
      "s",
      "s",
      "w",
      "o",
      "r",
      "d"
    ],
    "userName": "userName"
  }'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete migration source (partner) identified by {migPtrId} from HPE Alletra Storage MP B10000 system {systemId}

Request

Delete migration source (partner) identified by {migPtrId} from HPE Alletra Storage MP B10000 system {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
migPtrIdstringrequired

ID of the HPE Alletra Storage MP B10000 Migration Source.

Example: 2c9412f703442635dc11a6e2109ed784
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/migration-partners/2c9412f703442635dc11a6e2109ed784 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

object-notification-clients

The Object Notification Client API provides endpoints for managing and configuring object notification clients.

Operations

ports

The ports API allows the management of ports.

Operations

protection-policies

Protection policy APIs

Operations

protection-software-update-policies

Protection and Software update policy APIs

Operations

setup-blueprints

Blueprint Service API

Operations

setup-devices

Setup Orchestrator API

Operations

shelves

The shelves API allows the management of shelves.

Operations

storage-nodes

The Storage Node API provides endpoints for managing and configuring storage nodes.

Operations

storage-systems

The storage-systems API allows management of storage devices.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

system-settings

The system settings API allows the monitoring of system settings for the device.

Operations

filesystems

Operations

vvolscs

Operations