Vcenter V Storage Object Manager Delete V Storage Object Task

Vcenter V Storage Object Manager 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}/VcenterVStorageObjectManager/{moId}/DeleteVStorageObject_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 VcenterVStorageObjectManager/{moId}.

string
release
Required

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

Request Body
DeleteVStorageObjectRequestType of type(s) application/json
Required

Show optional properties

{
    "id": {},
    "datastore": {}
}
{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
id
Required

The ID of the virtual storage object to be deleted.

datastore
Required

The datastore where the virtual storage object is located.

Required privileges: Datastore.FileManagement

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}/VcenterVStorageObjectManager/{moId}/DeleteVStorageObject_Task
On This Page
Virtual Infrastructure Operations
POST
Vcenter V Storage Object Manager Revert V Storage Object Task
POST
Vcenter V Storage Object Manager Attach Tag To V Storage Object
POST
Vcenter V Storage Object Manager Clear V Storage Object Control Flags
POST
Vcenter V Storage Object Manager Clone V Storage Object Task
POST
Vcenter V Storage Object Manager Create Disk Task
POST
Vcenter V Storage Object Manager Create Disk From Snapshot Task
POST
Vcenter V Storage Object Manager V Storage Object Create Snapshot Task
POST
Vcenter V Storage Object Manager V Storage Object Create Snapshot Ex Task
POST
Vcenter V Storage Object Manager Delete Snapshot Task
POST
Vcenter V Storage Object Manager V Storage Object Delete Snapshot Ex Task
POST
Vcenter V Storage Object Manager V Storage Object Delete Snapshot Ex2 Task
POST
Vcenter V Storage Object Manager Delete V Storage Object Task
POST
Vcenter V Storage Object Manager Delete V Storage Object Ex Task
POST
Vcenter V Storage Object Manager Detach Tag From V Storage Object
POST
Vcenter V Storage Object Manager Extend Disk Task
POST
Vcenter V Storage Object Manager V Storage Object Extend Disk Ex Task
POST
Vcenter V Storage Object Manager Inflate Disk Task
POST
Vcenter V Storage Object Manager List Tags Attached To V Storage Object
POST
Vcenter V Storage Object Manager List V Storage Object
POST
Vcenter V Storage Object Manager List V Storage Objects Attached To Tag
POST
Vcenter V Storage Object Manager Vstorage Object V Center Query Changed Disk Areas
POST
Vcenter V Storage Object Manager Query Virtual Disk Uuid Ex
POST
Vcenter V Storage Object Manager Reconcile Datastore Inventory Task
POST
Vcenter V Storage Object Manager Reconcile Datastore Inventory Ex Task
POST
Vcenter V Storage Object Manager Register Disk
POST
Vcenter V Storage Object Manager Relocate V Storage Object Task
POST
Vcenter V Storage Object Manager Rename V Storage Object
POST
Vcenter V Storage Object Manager Rename V Storage Object Ex
POST
Vcenter V Storage Object Manager Repair V Storage Object Chain Task
POST
Vcenter V Storage Object Manager Retrieve Snapshot Details
POST
Vcenter V Storage Object Manager Retrieve Snapshot Info
POST
Vcenter V Storage Object Manager Retrieve V Storage Infrastructure Object Policy
POST
Vcenter V Storage Object Manager Retrieve V Storage Object
POST
Vcenter V Storage Object Manager Retrieve V Storage Object Associations
POST
Vcenter V Storage Object Manager Retrieve V Storage Object State
POST
Vcenter V Storage Object Manager Revert V Storage Object Ex Task
POST
Vcenter V Storage Object Manager Schedule Reconcile Datastore Inventory
POST
Vcenter V Storage Object Manager Set V Storage Object Control Flags
POST
Vcenter V Storage Object Manager Set Virtual Disk Uuid Ex Task
POST
Vcenter V Storage Object Manager Unregister Disk Task
POST
Vcenter V Storage Object Manager Update V Storage Infrastructure Object Policy Task
POST
Vcenter V Storage Object Manager Update V Storage Object Crypto Task
POST
Vcenter V Storage Object Manager V Center Update V Storage Object Metadata Ex Task
POST
Vcenter V Storage Object Manager Update V Storage Object Policy Task