Skip to content
/vvolscs

HPE Greenlake For Storage Fleet REST APIs (1.2.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

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

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 the management of storage device.

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

vvolscs

Operations

Creates VMware storage container on HPE Alletra Storage MP B10000 storage system identified by {systemId}

Request

Creates VMware storage container on HPE Alletra Storage MP B10000 storage system identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Bodyapplication/jsonrequired
namestringrequired

Storage Container Name.

Example: "<resource_name>"
domainstring or null

Domain that the resource belongs to

Example: "domain"
hostIdsArray of strings or null

Host IDs

Example: ["id","id"]
hostSetIdsArray of strings or null

Host Set IDs

Example: ["id","id"]
scTypestring or null

Field is supported from 10.4.0 and later. Indicates the type of the VMware VASA storage container that would get created in the system. Valid values are NVMe and SCSI.

Example: "SCSI"
transportTypestring or null

Transport type of the NVMe protocol. The value will be either NVMe/FC or NVMe/TCP and the default value is NVMe/FC. This parameter is supported from the system OS version 10.5.0. Transport type will be used to attach or detach a NVMe/TCP or NVMe/FC hosts/host groups from a storage container created with NVMe protocol.

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/vvolscs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<resource_name>"
  }'

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"
}

Attach host to storage container identified by {vvolscId} from HPE Alletra Storage MP B10000

Request

Attach host to storage container identified by {volumeId} from HPE Alletra Storage MP B10000

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
vvolscIdstringrequired

Storage container UID

Example: d09b59cd7bd07a4e9559e78dcea07498
Bodyapplication/jsonrequired
actionstring

Attach or Detach action name

parameterobject
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/vvolscs/d09b59cd7bd07a4e9559e78dcea07498/attach \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

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"
}

Detach host from storage container identified by {vvolscId} from HPE Alletra Storage MP B10000

Request

Detach host from storage container identified by {volumeId} from HPE Alletra Storage MP B10000

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
vvolscIdstringrequired

Storage container UID

Example: d09b59cd7bd07a4e9559e78dcea07498
Bodyapplication/jsonrequired
actionstring

Attach or Detach action name

parameterobject
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/vvolscs/d09b59cd7bd07a4e9559e78dcea07498/detach \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

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"
}