VM Parent topic

Parameter
Data Type
Description
Required?
vm
Container
The container of information about a virtual machine.
Property type: Element
Yes
vm.imageGUID
String
The GUID of the virtual machine.
Property type: Attribute
Yes
vm.imageID
String
The identifier of the virtual machine image.
Note
Note
If the image is published by SecureCloud 3.0, this identifier is the identifier on the Cloud Service Provider. If the image is published by SecureCloud 3.5 or later, the values of vm.imageID and vm.imageGUID are the same.
Property type: Attribute
Yes
vm.imageName
String
The name of the virtual machine.
Property type: Attribute
Yes
vm.href
String
The callback URL to obtain detailed information about this virtual machine.
Property type: Attribute
Yes
vm.version
Double
The API version.
Property type: Attribute
No
vm.imageDescription
String
The description of the virtual machine.
Property type: Element
Valid value: any string of 1-360 characters
No
vm.instanceID
String
The identifier of a running instance of the virtual machine.
Property type: Attribute
No
vm.instanceGUID
String
The GUID of a running instance of the virtual machine.
Property type: Attribute
No
vm.Provider
Container: Provider
The Cloud Service Provider (CSP) which the virtual machine belongs to.
Property type: Element
No
vm.Platform
Enumeration
The platform running on the virtual machine.
Property type: Element
Valid values:
  • Linux_32: a 32-bit Linux operating system.
  • Linux_64: a 64-bit Linux operating system.
  • Windows_x86: a 32-bit Windows operating system.
  • Windows_x64: a 64-bit Windows operating system.
No
vm.SecureCloudAgent
Container: SecureCloudAgent
The container for information about the associated SecureCloud agent.
Property type: Element
No
vm.AutoProvision
Container: AutoProvision
Indicates whether the virtual machine supports auto-provision.
Property type: Element
Valid values:
  • On: the virtual machine supports auto-provision.
  • Off: the virtual machine does not support auto-provision.
No
vm.nonEncryptedDeviceCount
Integer
The amount of unencrypted devices that are owned by the virtual machine.
Property type: Attribute
No
vm.pendingDeviceCount
Integer
The amount of devices that are waiting to be encrypted.
Property type: Attribute
No
vm.encryptingDeviceCount
Integer
The amount of devices that are being encrypted.
Property type: Attribute
No
vm.encryptedDeviceCount
Integer
The amount of encrypted devices.
Property type: Attribute
No
vm.devices
Container
The array of devices of the virtual machine.
Property type: Element
No
vm.SecurityGroupGUID
String
The GUID of a policy the virtual machine belongs to.
Property type: Attribute
No
vm.lastModified
DateTime
The date and time this virtual machine was last modified.
Property type: Attribute
Valid value: a date and time in the format "yyyy-MM-ddThh:mm:ss.sss, UTC"
No