Skip to content
/
Refresh the Software Cata...

HPE GreenLake for Private Cloud Business Edition System APIs (1.1.0)

HPE GreenLake for Private Cloud Business Edition System APIs

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/

configuration-analysis-reports

APIs to trigger and fetch configuration analysis rules execution results for system

Operations

systems

APIs for HPE GreenLake for Private Cloud Business Edition system operations.

Operations

Get all System Software Catalogs.

Request

Returns a list of all system software catalogs. Use 'select' and 'filter' query parameters to customize the response returned by this API. For example, to get the End User License Agreement (EULA) for catalog version 1.2.3.4, use '?select=eula&filter=version eq 1.2.3.4'. To get recommended systems for precheck to a given catalog version, use '?select=systemsWithUpdatePath&filter=version eq 1.2.3.4'.

Security
bearer
Query
selectstring

A list of properties in the items collection to include in the response.

Example: select=eula,systemsWithUpdatePath
filterstring

The expression to filter responses. The property names which are of type string should be passed in quotes('') and nested property names should be passed with "/" as the separator. Filtering is supported with following properties:

  • eula
  • createdAt
  • customerId
  • generation
  • id
  • name
  • resourceUri
  • type
  • updatedAt
  • hypervisor/name
  • hypervisor/releaseDate
  • hypervisor/releaseNotesUrl
  • hypervisor/version
  • releaseDate
  • serverFirmware/name
  • serverFirmware/releaseDate
  • serverFirmware/releaseNotesUrl
  • serverFirmware/version
  • storageConnectionManager/name
  • storageConnectionManager/releaseDate
  • storageConnectionManager/releaseNotesUrl
  • storageConnectionManager/version
  • storageSoftware/name
  • storageSoftware/releaseDate
  • storageSoftware/releaseNotesUrl
  • storageSoftware/version
  • version
Example: filter=hypervisor/name eq 'ESXi'
limitinteger(int32)[ 10 .. 100 ]

Use limit in conjunction with offset for paging, e.g.: offset=30&&limit=10. Limit is the maximum number of items to include in the response.

Default 10
Example: limit=10
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/system-software-catalogs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects(SoftwareCatalog)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​eulastring

End User License Agreement for this software catalog

items[].​systemsWithUpdatePathArray of objects(SystemForUpdate)

List of systems having update path to this software catalog

items[].​namestring

A system specified name for the resource.

items[].​hypervisorobject
items[].​hypervisorManagerobject
items[].​releaseDatestring

Release date of the software catalog

items[].​serverFirmwareobject
items[].​storageConnectionManagerobject
items[].​storageSoftwareobject
items[].​versionstring

Catalog version

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

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

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

Get the System Software Catalog with specified id.

Request

Returns the system software catalog for the specified id. Includes versions of the catalog and all constituent software components along with the End User License Agreement and a list of systems with update path to the corresponding catalog version.

Security
bearer
Path
idstringrequired
Query
selectstring

A list of properties in the items collection to include in the response.

Example: select=eula,systemsWithUpdatePath
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/system-software-catalogs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

eulastring

End User License Agreement for this software catalog

systemsWithUpdatePathArray of objects(SystemForUpdate)

List of systems having update path to this software catalog

namestring

A system specified name for the resource.

hypervisorobject
hypervisorManagerobject
releaseDatestring

Release date of the software catalog

serverFirmwareobject
storageConnectionManagerobject
storageSoftwareobject
versionstring

Catalog version

Response
application/json
{
  "eula": "string",
  "systemsWithUpdatePath": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "hypervisor": {
    "name": "string",
    "releaseDate": "string",
    "releaseNotesUrl": "string",
    "version": "string"
  },
  "hypervisorManager": {
    "name": "string",
    "releaseDate": "string",
    "releaseNotesUrl": "string",
    "version": "string"
  },
  "releaseDate": "string",
  "serverFirmware": {
    "name": "string",
    "releaseDate": "string",
    "releaseNotesUrl": "string",
    "version": "string"
  },
  "storageConnectionManager": {
    "name": "string",
    "releaseDate": "string",
    "releaseNotesUrl": "string",
    "version": "string"
  },
  "storageSoftware": {
    "name": "string",
    "releaseDate": "string",
    "releaseNotesUrl": "string",
    "version": "string"
  },
  "version": "string"
}

Get information about all systems subject to query parameters.

Request

Returns the systems and their properties defined by the query parameters. Retrieving all of the properties for the system can take a long time because the amount of data is large. Use the ‘select’ query parameter to choose only the properties you want to retrieve for a system. For example, to get details of the id, name and software information for each system, use ‘?select=id,name,softwareInfo’

Security
bearer
Query
selectstring

Query parameter listing the properties of system information to fetch. Although Hypervisor Clusters collection (property hypervisorClusters) can be selected, selecting elements of the collection is not supported. Similarly, hypervisor clusters update status collection (property softwareInfo.hypervisorClusters) can be selected, but, selecting elements of the collection is not supported in the select query parameter. Although systemVms collection can be selected, selecting elements of the collection is not supported.

Example: select=id,name,softwareInfo
offsetinteger

Use offset in conjunction with limit for paging, e.g.: offset=30&&limit=10. Offset is the number of items from the beginning of the result set to the first item included in the response.

Example: offset=30
limitinteger(int32)[ 10 .. 100 ]

Use limit in conjunction with offset for paging, e.g.: offset=30&&limit=10. Limit is the maximum number of items to include in the response.

Default 10
Example: limit=10
filterstring

The expression to filter responses. This API doesn't support filtering based on hypervisorClusters collection property, softwareInfo.hypervisorClusters and systemVms collection property. Request with filter based on the above mentioned properties will be treated as a Bad Request with 400 Error.

Example: filter=health/overallHealth eq OK
sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending. This API doesn't support sorting based on hypervisorClusters collection property, softwareInfo.hypervisorClusters collection property and systemVms collection property. Request with sort based on the above mentioned properties will be treated as a Bad Request with 400 Error.

Example: sort=id desc,name asc
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects(SystemInfo)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​associatedResourceCountsobject(AssociatedResourceCounts)
items[].​computeUsageobject(SystemComputeUsage)
items[].​configAnalysisStatusobject(ConfigAnalysisStatus)
items[].​healthobject(SystemHealth)
items[].​hypervisorClustersArray of objects(HypervisorCluster)

List of hypervisor clusters in the system with their software details.

items[].​locationobject(SystemLocation)
items[].​softwareInfoobject

system software information.

items[].​stackTypestring

Stack Type of the system

Enum"DHCI""SIMPLIVITY"
items[].​statestring

Current state of the system

Enum"OFFLINE""ONLINE""INITIALIZED"
items[].​storageSystemobject(StorageSystem)
items[].​storageUsageobject(StorageUsage)
items[].​systemVmsArray of objects(SystemVm)

List of system virtual machine information.

items[].​namestring

A system specified name for the resource.

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

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

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

Get information about the specified system subject to query parameters.

Request

Returns the system properties specified in the query parameters. Retrieving all of the properties for the system can take a long time because the amount of data is large. Use the 'select' query parameter to choose only the properties you want to retrieve.

For example, to get details of the system's id, name and software information, use '?select=id,name,softwareInfo'

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the system, usually a UUID.

Query
selectstring

Query parameter listing the properties of system information to fetch. Although Hypervisor Clusters collection (property hypervisorClusters) can be selected, selecting elements of the collection is not supported. Similarly, hypervisor clusters update status collection (property softwareInfo.hypervisorClusters) can be selected, but, selecting elements of the collection is not supported in the select query parameter.

Example: select=select=id,name,softwareInfo,computeUsage,associatedResourceCount 
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

associatedResourceCountsobject(AssociatedResourceCounts)
computeUsageobject(SystemComputeUsage)
configAnalysisStatusobject(ConfigAnalysisStatus)
healthobject(SystemHealth)
hypervisorClustersArray of objects(HypervisorCluster)

List of hypervisor clusters in the system with their software details.

locationobject(SystemLocation)
softwareInfoobject

system software information.

stackTypestring

Stack Type of the system

Enum"DHCI""SIMPLIVITY"
statestring

Current state of the system

Enum"OFFLINE""ONLINE""INITIALIZED"
storageSystemobject(StorageSystem)
storageUsageobject(StorageUsage)
systemVmsArray of objects(SystemVm)

List of system virtual machine information.

namestring

A system specified name for the resource.

Response
application/json
{
  "associatedResourceCounts": {
    "datastoreCount": 0,
    "hypervisorClusterCount": 0,
    "serversCount": 0,
    "storageArrayCount": 0,
    "switchesCount": 0,
    "vmCount": 0
  },
  "computeUsage": {
    "cpuCapacityMhz": 0,
    "cpuUsedMhz": 0,
    "memoryCapacityBytes": 0,
    "memoryUsedBytes": 0
  },
  "configAnalysisStatus": {
    "createdAt": "string",
    "createdBy": "string",
    "nextScheduledRunTime": "string",
    "ruleRunStartTime": "string",
    "totalFailed": 0,
    "totalPassed": 0,
    "totalWarning": 0
  },
  "health": {
    "network": "OK",
    "overallHealth": "OK",
    "servers": "OK",
    "storage": "OK"
  },
  "hypervisorClusters": [
    { … }
  ],
  "location": {
    "city": "string",
    "countryCode": "string",
    "latitude": "string",
    "longitude": "string",
    "stateCode": "string",
    "zipCode": "string"
  },
  "softwareInfo": {
    "currentUpdateStatus": { … },
    "hypervisorClusters": [ … ],
    "lastUpdatedOn": "2019-08-24T14:15:22Z",
    "precheckValidUntil": "2019-08-24T14:15:22Z"
  },
  "stackType": "DHCI",
  "state": "OFFLINE",
  "storageSystem": {
    "compressionRatio": 0,
    "dedupeRatio": 0,
    "groupLeaderName": "string",
    "groupLeaderSerialNumber": "string",
    "groupName": "string",
    "groupState": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "resourceUri": "string"
  },
  "storageUsage": {
    "sizeInBytes": 0,
    "usageInBytes": 0
  },
  "systemVms": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Modifies the system specified by systemId.

Request

Modify specified system.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the system, usually a UUID.

Bodyapplication/merge-patch+jsonrequired
locationobject
curl -i -X PATCH \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Success

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

associatedResourceCountsobject(AssociatedResourceCounts)
computeUsageobject(SystemComputeUsage)
configAnalysisStatusobject(ConfigAnalysisStatus)
healthobject(SystemHealth)
hypervisorClustersArray of objects(HypervisorCluster)

List of hypervisor clusters in the system with their software details.

locationobject(SystemLocation)
softwareInfoobject

system software information.

stackTypestring

Stack Type of the system

Enum"DHCI""SIMPLIVITY"
statestring

Current state of the system

Enum"OFFLINE""ONLINE""INITIALIZED"
storageSystemobject(StorageSystem)
storageUsageobject(StorageUsage)
systemVmsArray of objects(SystemVm)

List of system virtual machine information.

namestring

A system specified name for the resource.

Response
application/json
{
  "associatedResourceCounts": {
    "datastoreCount": 0,
    "hypervisorClusterCount": 0,
    "serversCount": 0,
    "storageArrayCount": 0,
    "switchesCount": 0,
    "vmCount": 0
  },
  "computeUsage": {
    "cpuCapacityMhz": 0,
    "cpuUsedMhz": 0,
    "memoryCapacityBytes": 0,
    "memoryUsedBytes": 0
  },
  "configAnalysisStatus": {
    "createdAt": "string",
    "createdBy": "string",
    "nextScheduledRunTime": "string",
    "ruleRunStartTime": "string",
    "totalFailed": 0,
    "totalPassed": 0,
    "totalWarning": 0
  },
  "health": {
    "network": "OK",
    "overallHealth": "OK",
    "servers": "OK",
    "storage": "OK"
  },
  "hypervisorClusters": [
    { … }
  ],
  "location": {
    "city": "string",
    "countryCode": "string",
    "latitude": "string",
    "longitude": "string",
    "stateCode": "string",
    "zipCode": "string"
  },
  "softwareInfo": {
    "currentUpdateStatus": { … },
    "hypervisorClusters": [ … ],
    "lastUpdatedOn": "2019-08-24T14:15:22Z",
    "precheckValidUntil": "2019-08-24T14:15:22Z"
  },
  "stackType": "DHCI",
  "state": "OFFLINE",
  "storageSystem": {
    "compressionRatio": 0,
    "dedupeRatio": 0,
    "groupLeaderName": "string",
    "groupLeaderSerialNumber": "string",
    "groupName": "string",
    "groupState": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "resourceUri": "string"
  },
  "storageUsage": {
    "sizeInBytes": 0,
    "usageInBytes": 0
  },
  "systemVms": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Initiates addition of a hypervisor cluster to system with the given id.

Request

Adds the specified hypervisor cluster to the specified system. The user must have permissions to update this system. Returns a task identifier to be used by clients to track the progress of the operation.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the system, usually a UUID.

Bodyapplication/jsonrequired
configureVdsboolean

Specifies if vSphere Distributed Switch (VDS) should be configured for the hypervisor cluster being added.

hypervisorClusterNamestring

Name of the hypervisor cluster to be added.

vsphereDatacenterNamestring

vSphere datacenter name where this hypervisor cluster is to be added.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}/add-hypervisor-cluster' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Add Hypervisor Cluster request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Initiate software update prechecks on the given System.

Request

Initiate a set of software update prechecks on the specified system and hypervisor clusters in it using the specified software catalog version. This operation validates whether the software on system and its hypervisor clusters are ready to be updated to the target software catalog version.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the System, usually a UUID.

Bodyapplication/jsonrequired
catalogVersionstringrequired

Version of the target software catalog for the software precheck/update request.

hypervisorClusterIdsArray of strings(uuid)

List of Unique Identifiers (usually UUIDs) of Hypervisor Clusters in the system for which software update prechecks operation is to be initiated. If omitted, software update prechecks operation will be initiated on all Hypervisor Clusters available in the system.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}/software-prechecks' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "catalogVersion": "string"
  }'

Responses

Software prechecks request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Initiate software update on the given System.

Request

Initiate a software update on the specified system and the hypervisor clusters in it using the specified software catalog version. Before invoking this API, ensure that software update prechecks on the same parameters successfully completed and is valid.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the System, usually a UUID.

Bodyapplication/jsonrequired
catalogVersionstringrequired

Version of the target software catalog for the software precheck/update request.

hypervisorClusterIdsArray of strings(uuid)

List of Unique Identifiers (usually UUIDs) of Hypervisor Clusters in the system for which software update operation is to be initiated. If omitted, software update operation will be initiated on all Hypervisor Clusters available in the system.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}/software-update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "catalogVersion": "string"
  }'

Responses

Software update request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Resume the failed and paused software update on the selected System.

Request

Resume the failed and paused software update on the specified system. Invoke this API only after fixing the problems reported in software update.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the System, usually a UUID.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}/software-update-resume' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Software update resume request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

Refresh the Software Catalog versions available for the system identified by id.

Request

Refresh the software catalogs and software versions on the specified system. The current and available software catalog versions are recomputed based on the component versions running on the system and software catalogs available for update.

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the system, usually a UUID.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/private-cloud-business/v1beta1/systems/{id}/software-version-refresh' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Software version refresh request is accepted.

Headers
Locationstring

Asynchronous operation URI. Use this to track the progress of the asynchronous operation.

Bodyapplication/json
object(EmptyResponse)
Response
application/json
{}

vm-provisioning-policies

Virtual Machine Provisioning Policies operations

Operations

servers

Operations