Create Block Device

Create Block Device

Following disk custom properties can be passed while creating a block device:

1. dataStore: Defines name of the datastore in which the disk has to be provisioned. 

2. storagePolicy: Defines name of the storage policy in which the disk has to be provisioned. If name of the datastore is specified in the custom properties then, datastore takes precedence.

3. provisioningType: Defines the type of provisioning. For eg. thick/thin. 
Request
URI
POST
https://api.mgmt.cloud.vmware.com//iaas/api/block-devices
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body

Disk Specification instance

BlockDeviceSpecification of type(s) application/json
Required
{
    "capacityInGB": 78,
    "sourceReference": "ami-0d4cfd66",
    "encrypted": true,
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "name": "string",
    "description": "string",
    "diskContentBase64": "dGVzdA",
    "persistent": true,
    "projectId": "e058",
    "constraints": [
        {
            "expression": "ha:strong",
            "mandatory": false
        }
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
integer As int32 As int32
capacityInGB
Required

Capacity of the block device in GB.

string
sourceReference
Optional

Reference to URI using which the block device has to be created.

object
customProperties
Optional

Additional custom properties that may be used to extend the block device.

boolean
encrypted
Optional

Indicates whether the block device should be encrypted or not.

string
deploymentId
Optional

The id of the deployment that is associated with this resource

string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
diskContentBase64
Optional

Content of a disk, base64 encoded.

boolean
persistent
Optional

Indicates whether the block device should be persistent or not.

string
projectId
Required

The id of the project the current user belongs to.

array of Constraint
constraints
Optional

Constraints that are used to drive placement policies for the block device that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.

array of Tag
tags
Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

Responses
202

successful operation

Returns RequestTracker of type(s) application/json
{
    "name": "Power-off",
    "progress": 90,
    "resources": [
        "string"
    ],
    "id": "we655aew4e8e",
    "message": "In Progress",
    "status": "FINISHED",
    "selfLink": "/.../request-tracker/we655aew4e8e"
}
string
name
Optional

Name of the operation.

integer As int32 As int32
progress
Required

Progress of the request as percentage.

array of string
resources
Optional

Collection of resources.

string
id
Required

ID of this request.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
string
selfLink
Required

Self link of this request.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure