EncryptVMs() Parent topic

Description

Encrypt multiple virtual machines.

Interface

https://[SecureCloudService]/broker/API.svc/v3.5/vm/encrypt
Method: POST

Request

Refer to the following data types: Device, VM, and VMList.
Note
Note
Regarding the preserveData parameter, the valid values have the following special requirements:
  • yes: Encrypt the device while keeping all device data. Do not specify the filesystem and mountpoint elements.
  • no: Encrypt and format the device, erasing all device data. Specify the filesystem and mountpoint elements.

Response

Expected HTTP response code: 200 (OK)

Example Request URL

[POST]
https://ms.sample.securecloud.com/broker/API.svc/v3.5/vm/encrypt

Example Request Message

<vmList>
      <vms>
            <vm imageGUID="639F2224-637D-49AA-876B-AFBAD59AFADA">
                  <devices>
                        <device msUID="6068C4CA-A5A0-45AF-9266-6A2E9BC929EB" preserveData="no">
                              <fileSystem>ext3</fileSystem>
                              <volume>
                                    <mountPoint>/mnt/hd1</mountPoint>
                              </volume>
                        </device>
                        ...
                  </devices>
            </vm>
            ...
      </vms>
</vmList>

Example Response

n/a