CnsUnregisterVolumeSpec

CnsUnregisterVolumeSpec
CnsUnregisterVolumeSpec

Specifies the parameters required to unregister a volume from the vSphere environment.

Depending on the CnsUnregisterTargetVolumeTypeEnum specified, the unregistration process would also optionally demote the volume to VMDK.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "volumeId": {
        "_typeName": "string",
        "id": "string"
    },
    "targetVolumeType": "string"
}
volumeId
Required

The unique identifier of the volume to be unregistered.

string
targetVolumeType
Required

Specifies the final desired volume type after the unregistration operation.

This parameter dictates how the underlying storage volume should be treated or converted once its CNS metadata is removed.

Unregistering a block volume might convert it into a legacy VMDK or FCD The possible values for this field are enumerated in CnsUnregisterTargetVolumeTypeEnum.