Virtual Machine Promote Disks Task

Promotes disks on this virtual machine that have delta disk backings.

A delta disk backing is a way to preserve a virtual disk backing at some point in time. A delta disk backing is a file backing which in turn points to the original virtual disk backing (the parent). After a delta disk backing is added, all writes go to the delta disk backing. All reads first try the delta disk backing and then try the parent backing if needed.

Promoting does two things

Unlinking shared disk backings: All shared disk backings are copied from its parent to its home directory. This creates an exclusive, unshared version for the VM disks and removes the link to its parent from the delta disk, resulting in the creation of an independent VM with its own base disk.
Consolidation: Any disk backing which is not shared between multiple virtual machines and is not associated with a snapshot is consolidated with its child backing.

This operation is only supported if deltaDiskBackingsSupported is true.

This operation is only supported on VirtualCenter. If no work is required, an invocation completes successfully.

Required privileges: VirtualMachine.Provisioning.PromoteDisks

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/PromoteDisks_Task

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VirtualMachine/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body

PromoteDisksRequestType of type(s) application/json

Required

Show optional properties

{
    "unlink": false
}

{
    "unlink": false,
    "disks": [
        {
            "_typeName": "string",
            "key": 0,
            "deviceInfo": {
                "_typeName": "string",
                "label": "string",
                "summary": "string"
            },
            "backing": {
                "_typeName": "string"
            },
            "connectable": {
                "_typeName": "string",
                "migrateConnect": "string",
                "startConnected": false,
                "allowGuestControl": false,
                "connected": false,
                "status": "string"
            },
            "slotInfo": {
                "_typeName": "string"
            },
            "controllerKey": 0,
            "unitNumber": 0,
            "numaNode": 0,
            "deviceGroupInfo": {
                "_typeName": "string",
                "groupInstanceKey": 0,
                "sequenceId": 0
            },
            "capacityInKB": 0,
            "capacityInBytes": 0,
            "shares": {
                "_typeName": "string",
                "shares": 0,
                "level": "string"
            },
            "storageIOAllocation": {
                "_typeName": "string",
                "limit": 0,
                "shares": {
                    "_typeName": "string",
                    "shares": 0,
                    "level": "string"
                },
                "reservation": 0
            },
            "diskObjectId": "string",
            "vFlashCacheConfigInfo": {
                "_typeName": "string",
                "vFlashModule": "string",
                "reservationInMB": 0,
                "cacheConsistencyType": "string",
                "cacheMode": "string",
                "blockSizeInKB": 0
            },
            "iofilter": [
                "string"
            ],
            "vDiskId": {
                "_typeName": "string",
                "id": "string"
            },
            "vDiskVersion": 0,
            "virtualDiskFormat": "string",
            "nativeUnmanagedLinkedClone": false,
            "independentFilters": [
                {
                    "_typeName": "string"
                }
            ],
            "guestReadOnly": false,
            "diskChainBrokenIssue": "string"
        }
    ]
}

boolean

unlink

Required

If true, disks on powered-off VMs are unlinked before consolidation. This has no effect on powered-on VMs, as child disks are unlinked by default.

array of object

disks

Optional

The set of disks that are to be promoted. If this value is unset or the array is empty, all disks which have delta disk backings are promoted.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

TaskInProgress: if the virtual machine is busy.

NotSupported: if the host doesn't support disk promotion APIs.

InvalidState: if the virtual machine's power state changes during the execution of this method.

InvalidState: if the virtual machine is not ready to respond to such requests.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"unlink":"boolean"}' https://{api_host}/sdk/vim25/{release}/VirtualMachine/{moId}/PromoteDisks_Task

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations