Vcenter V Storage Object Manager Update V Storage Object Crypto Task

Update the crypto on a virtual storage object.

This is also intended for disk encryption, decryption and re-encryption. To encrypt the disk, profile must contain an encryption component. disksCrypto can be left as blank, which means caller doesn't care which key is used to encrypt the disk. If it's not blank, it has to be of type CryptoSpecEncrypt. To decrypt the disk, profile must not contain an encryption component. disksCrypto can be left as blank, if not, it has be of type CryptoSpecDecrypt. To re-encrypt the disk, profile must contain an encryption component. disksCrypto cannot be left as blank. It has to be of type either CryptoSpecShallowRecrypt or CryptoSpecDeepRecrypt.

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}/UpdateVStorageObjectCrypto_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 8.0.3.0 APIs.

Request Body

UpdateVStorageObjectCryptoRequestType of type(s) application/json

Required

Show optional properties

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

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "profile": [
        {
            "_typeName": "string"
        }
    ],
    "disksCrypto": {
        "_typeName": "string",
        "parent": "DiskCryptoSpec Object",
        "crypto": {
            "_typeName": "string"
        }
    }
}

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

array of VirtualMachineProfileSpec

profile

Optional

New profile requirement on the virtual storage object.

DiskCryptoSpec

disksCrypto

Optional

This data object type contains the crypto information of all disks along the chain

Authentication

This operation uses the following authentication methods.

Session

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 while updating the virtual storage object policy.

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

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

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": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations