Vim Cluster Vsan Vc Disk Management System Vsan Delete Storage Pool Disk

This API can be used to delete a single or multiple disks from storage pool.

The disk(s) can be specified by their uniquely identifiable disk uuid.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/VsanDeleteStoragePoolDisk

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 VimClusterVsanVcDiskManagementSystem/{moId}.

string

release

Required

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

Request Body

VsanDeleteStoragePoolDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "cluster": {},
    "spec": {}
}

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "spec": {
        "_typeName": "string",
        "diskUuids": [
            "string"
        ],
        "maintenanceSpec": {
            "_typeName": "string",
            "vsanMode": {
                "_typeName": "string",
                "objectAction": "string"
            },
            "purpose": "string",
            "evacMode": {
                "_typeName": "string",
                "workloadNonDisruptive": false
            }
        }
    }
}

cluster

Required

The vSAN cluster which owns the given storage pool disk(s).

spec

Required

The specification to delete vSAN storage pool. Please reference to VimVsanHostDeleteStoragePoolDiskSpec.

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

VsanFault: If any error happens during storage pool removal stage.

Returns VsanFault of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_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 '{"cluster":"{}","spec":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/VsanDeleteStoragePoolDisk

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vim Cluster Vsan Vc Disk Management System Vsan Add Storage Pool Disk