Skip to content
Internal API Catalog
/
HPE GreenLake for Private Cloud Business Edition System APIs
/
API reference
/
vm-provisioning-policies
/
Create VM provisioning policy

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

HPE GreenLake for Private Cloud Business Edition System APIs

Download OpenAPI description
private-cloud-business-api.json
private-cloud-business-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/

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/

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

vm-provisioning-policies

Virtual Machine Provisioning Policies operations

Operations

Get a list of VM provisioning policies

Request

Returns a list of VM provisioning policies according to the given query parameters for paging, filtering, and sorting.

Security
bearer
Query
offsetinteger

The number of items to omit from the beginning of the result set. Use offset in conjunction with limit for pagination. For example, "offset=30&limit=10" indicates the fourth page of 10 items.

Example: offset=30
limitinteger(int32)[ 1 .. 1000 ]

The maximum number of items to include in the response. Use offset in conjunction with limit for pagination. For example, "offset=30&limit=10" indicates the fourth page of 10 items.

Default 20
Example: limit=10
filterstring

An expression to filter the results. Filtering is supported with following attributes:

  • name
  • id
  • timestamp
  • clusterid
  • deduplication
  • allFlash
  • encryption.cipher
  • associatedvmid
  • associatedvmname
Example: filter=name eq 'vmpp'
sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc").

Example: sort=name asc
selectstring

A list of properties to include in the response.

Example: select=id,name
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/vm-provisioning-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of VM Provisioning Policies

Bodyapplication/json
countintegerrequired

Total number of records returned.

itemsArray of objects(VMProvisioningPolicy)required
items[].​idstring(uuid)required

UUID string uniquely identifying the VM provisioning policy.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​typestringread-onlyrequired

The type of resource.

items[].​namestring<= 80 charactersrequired

A user friendly name to identify the VM provisioning policy.

Example: "myProvisioningPolicy"
items[].​storageTypestringrequired

Storage Type of the system.

Default "Alletra dHCI"
Value"Alletra dHCI"
items[].​associatedObjectsArray of objects(AssociatedObj)required

Objects that the VM provisioning policy should be associated with.

items[].​associatedObjects[].​clusterIdstringrequired

Identifier of the system cluster.

items[].​associatedObjects[].​clusterNamestringrequired

Name of the system cluster.

items[].​associatedObjects[].​generationinteger(int64)read-only

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[].​associatedObjects[].​resourceUristring

The URI reference for this resource.

items[].​associatedObjects[].​typestringread-only

The type of resource.

items[].​associatedObjects[].​associatedDatastoresArray of objects(AssociatedDS)

datastores that the VM provisioning policy should be associated with.

items[].​associatedObjects[].​associatedVmCountinteger

number of associated VMs

items[].​associatedObjects[].​associatedVmsArray of objects(AssociatedVM)

Objects that the VM provisioning policy should be associated with.

items[].​associatedObjects[].​storageProfileIdstring

An identifier for the storage profile.

items[].​createdAtstring(date-time)
items[].​customerIdstringread-only

The customer application identifier

items[].​descriptionstring<= 255 characters

A brief description of the VM provisioning policy.

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

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[].​performancePolicyobject(PerformancePolicyWithId)

Performance policy with identifier.

items[].​protectionPolicyobject(ProtectionPolicy)

Protection policy.

items[].​resourceUristringread-only

The self reference for this resource.

items[].​updatedAtstring(date-time)
items[].​volumeInfoobject(VolumeInfo)

DHCI volume attributes

offsetintegerrequired

The number of items to skip before starting to collect the result set

totalinteger

Total number of documents matching filter criteria.

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

Create VM provisioning policy

Request

This API aids in creation of virtual machine provisioning policy

Security
bearer
Bodyapplication/jsonrequired
namestring<= 80 charactersrequired

A user friendly name to identify the VM provisioning policy.

storageTypestringrequired

Storage Type of the system.

Default "Alletra dHCI"
Value"Alletra dHCI"
descriptionstring<= 255 characters

A brief description of the VM provisioning policy.

protectionPolicyobject

Protection policy.

volumeInfoobject(VolumeInfo)

DHCI volume attributes

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/vm-provisioning-policies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "myProvisioningPolicy",
    "storageType": "Alletra dHCI"
  }'

Responses

Success

Bodyapplication/json
idstring(uuid)required

UUID string uniquely identifying the VM provisioning policy.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
typestringread-onlyrequired

The type of resource.

namestring<= 80 charactersrequired

A user friendly name to identify the VM provisioning policy.

Example: "myProvisioningPolicy"
storageTypestringrequired

Storage Type of the system.

Default "Alletra dHCI"
Value"Alletra dHCI"
associatedObjectsArray of objects(AssociatedObj)required

Objects that the VM provisioning policy should be associated with.

associatedObjects[].​clusterIdstringrequired

Identifier of the system cluster.

associatedObjects[].​clusterNamestringrequired

Name of the system cluster.

associatedObjects[].​generationinteger(int64)read-only

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.

associatedObjects[].​resourceUristring

The URI reference for this resource.

associatedObjects[].​typestringread-only

The type of resource.

associatedObjects[].​associatedDatastoresArray of objects(AssociatedDS)

datastores that the VM provisioning policy should be associated with.

associatedObjects[].​associatedVmCountinteger

number of associated VMs

associatedObjects[].​associatedVmsArray of objects(AssociatedVM)

Objects that the VM provisioning policy should be associated with.

associatedObjects[].​storageProfileIdstring

An identifier for the storage profile.

createdAtstring(date-time)
customerIdstringread-only

The customer application identifier

descriptionstring<= 255 characters

A brief description of the VM provisioning policy.

generationinteger(int64)read-only

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.

performancePolicyobject(PerformancePolicyWithId)

Performance policy with identifier.

protectionPolicyobject(ProtectionPolicy)

Protection policy.

resourceUristringread-only

The self reference for this resource.

updatedAtstring(date-time)
volumeInfoobject(VolumeInfo)

DHCI volume attributes

Response
application/json
{
  "associatedObjects": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "description": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myProvisioningPolicy",
  "performancePolicy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "protectionPolicy": {
    "description": "string",
    "effectiveFromDateTime": "2020-03-03T05:03:08.902Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "overrides": { … }
  },
  "resourceUri": "string",
  "storageType": "Alletra dHCI",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "volumeInfo": {
    "allFlash": true,
    "conversionType": "CONVERSIONTYPE_THIN",
    "dataReduction": true,
    "deduplication": true,
    "encryption": { … },
    "qos": { … },
    "snapshotAllocWarning": 0,
    "userAllocWarning": 0
  }
}

Delete VM provisioning policy by policy id

Request

Deletes the specified VM provisioning policy

Security
bearer
Path
idstring(uuid)required

Unique identifier of a VM provisioning policy

curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/vm-provisioning-policies/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Get VM provisioning policy by policy id

Request

Returns details for the specified VM provisioning policy.

Security
bearer
Path
idstring(uuid)required

Unique identifier of a VM provisioning policy

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/vm-provisioning-policies/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Details of a VM provisioning policy

Bodyapplication/json
idstring(uuid)required

UUID string uniquely identifying the VM provisioning policy.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
typestringread-onlyrequired

The type of resource.

namestring<= 80 charactersrequired

A user friendly name to identify the VM provisioning policy.

Example: "myProvisioningPolicy"
storageTypestringrequired

Storage Type of the system.

Default "Alletra dHCI"
Value"Alletra dHCI"
associatedObjectsArray of objects(AssociatedObj)required

Objects that the VM provisioning policy should be associated with.

associatedObjects[].​clusterIdstringrequired

Identifier of the system cluster.

associatedObjects[].​clusterNamestringrequired

Name of the system cluster.

associatedObjects[].​generationinteger(int64)read-only

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.

associatedObjects[].​resourceUristring

The URI reference for this resource.

associatedObjects[].​typestringread-only

The type of resource.

associatedObjects[].​associatedDatastoresArray of objects(AssociatedDS)

datastores that the VM provisioning policy should be associated with.

associatedObjects[].​associatedVmCountinteger

number of associated VMs

associatedObjects[].​associatedVmsArray of objects(AssociatedVM)

Objects that the VM provisioning policy should be associated with.

associatedObjects[].​storageProfileIdstring

An identifier for the storage profile.

createdAtstring(date-time)
customerIdstringread-only

The customer application identifier

descriptionstring<= 255 characters

A brief description of the VM provisioning policy.

generationinteger(int64)read-only

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.

performancePolicyobject(PerformancePolicyWithId)

Performance policy with identifier.

protectionPolicyobject(ProtectionPolicy)

Protection policy.

resourceUristringread-only

The self reference for this resource.

updatedAtstring(date-time)
volumeInfoobject(VolumeInfo)

DHCI volume attributes

Response
application/json
{
  "associatedObjects": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "description": "string",
  "generation": 0,
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myProvisioningPolicy",
  "performancePolicy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "protectionPolicy": {
    "description": "string",
    "effectiveFromDateTime": "2020-03-03T05:03:08.902Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "overrides": { … }
  },
  "resourceUri": "string",
  "storageType": "Alletra dHCI",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "volumeInfo": {
    "allFlash": true,
    "conversionType": "CONVERSIONTYPE_THIN",
    "dataReduction": true,
    "deduplication": true,
    "encryption": { … },
    "qos": { … },
    "snapshotAllocWarning": 0,
    "userAllocWarning": 0
  }
}

Update VM provisioning policy by policy id

Request

Update attributes of the specified VM provisioning policy

Security
bearer
Path
idstring(uuid)required

Unique identifier of a VM provisioning policy

Bodyapplication/merge-patch+jsonrequired
descriptionstring<= 255 characters

A brief description of the VM provisioning policy.

protectionPolicyobject

Protection policy.

storageTypestring

Storage Type of the system.

Default "Alletra dHCI"
Value"Alletra dHCI"
volumeInfoobject(VolumeInfo)

DHCI volume attributes

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/vm-provisioning-policies/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

servers

Operations