Host V Storage Object Manager Host Delete V Storage Object Task

Host V Storage Object Manager Host Delete V Storage Object Task

Delete a virtual storage object and its associated backings.

Delete a virtual storage object and its associated backings.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostVStorageObjectManager/{moId}/HostDeleteVStorageObject_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 HostVStorageObjectManager/{moId}.

string

release

Required

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

Request Body

HostDeleteVStorageObjectRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {},
    "datastore": {}
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "isLcParentAttached": false
}

id

Required

The ID of the virtual storage object to be deleted.

datastore

Required

The datastore where the virtual storage object is located.

boolean

isLcParentAttached

Optional

Set to true if parent of linked clone is attached to VM, set to false if parent of linked clone is detached, unset is considered as false.

Since: vSphere API Release 9.1.0.0

Authentication

This operation uses the following authentication methods.

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

FileFault: If an error occurs when deleting the virtual storage object.

NotFound: If the specified virtual storage object cannot be found.

InvalidDatastore: If the operation cannot be performed on the datastore.

InvalidState: If the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted.

TaskInProgress: If the virtual storage object is busy.

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 '{"id":"{}","datastore":"{}"}' https://{api_host}/sdk/vim25/{release}/HostVStorageObjectManager/{moId}/HostDeleteVStorageObject_Task

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

Host V Storage Object Manager Host V Storage Object Revert Task

Host V Storage Object Manager Host Clear V Storage Object Control Flags

Host V Storage Object Manager Host Clone V Storage Object Task

Host V Storage Object Manager Host Create Disk Task

Host V Storage Object Manager Host V Storage Object Create Disk From Snapshot Task

Host V Storage Object Manager Host V Storage Object Create Snapshot Task

Host V Storage Object Manager V Storage Object Create Snapshot Ex Task

Host V Storage Object Manager Host V Storage Object Delete Snapshot Task

Host V Storage Object Manager V Storage Object Delete Snapshot Ex Task

Host V Storage Object Manager V Storage Object Delete Snapshot Ex2 Task

Host V Storage Object Manager Host Delete V Storage Object Task

Host V Storage Object Manager Host Delete V Storage Object Ex Task

Host V Storage Object Manager Host Extend Disk Task

Host V Storage Object Manager V Storage Object Extend Disk Ex Task

Host V Storage Object Manager Host Inflate Disk Task

Host V Storage Object Manager Host List V Storage Object

Host V Storage Object Manager Host Query Virtual Disk Uuid

Host V Storage Object Manager Host Reconcile Datastore Inventory Task

Host V Storage Object Manager Host Register Disk

Host V Storage Object Manager Host Relocate V Storage Object Task

Host V Storage Object Manager Host Rename V Storage Object

Host V Storage Object Manager Rename V Storage Object Ex

Host V Storage Object Manager Repair V Storage Object Chain Task

Host V Storage Object Manager Host V Storage Object Retrieve Snapshot Info

Host V Storage Object Manager Host Retrieve V Storage Infrastructure Object Policy

Host V Storage Object Manager Host Retrieve V Storage Object

Host V Storage Object Manager Host Retrieve V Storage Object Metadata

Host V Storage Object Manager Host Retrieve V Storage Object Metadata Value

Host V Storage Object Manager Host Retrieve V Storage Object State

Host V Storage Object Manager Revert V Storage Object Ex Task

Host V Storage Object Manager Host Schedule Reconcile Datastore Inventory

Host V Storage Object Manager Host Set V Storage Object Control Flags

Host V Storage Object Manager Host Set Virtual Disk Uuid Task

Host V Storage Object Manager Unregister Disk Task

Host V Storage Object Manager Host Update V Storage Object Metadata Task

Host V Storage Object Manager Host Update V Storage Object Metadata Ex Task