Device Parent topic

Parameter
Data Type
Description
Required?
device
Container
The container of information about a device object.
Property type: Element
Yes
device.id
String
The identifier of this device on the Cloud Service Provider (CSP).
Property type: Attribute
Yes
device.version
Double
The API version.
Property type: Attribute
No
device.msUID
String
The GUID of this device.
Property type: Attribute
No
device.name
String
The device name.
Property type: Attribute
No
device.href
String
The callback URL to obtain detailed information about this device.
Property type: Attribute
No
device.cspDeviceType
Container: CSPDeviceType
l
The Cloud Service Provider (CSP) device type.
Property type: Element
Valid values:
  • general
  • RAID
  • ephemeral
  • root
No
device.parentGUID
String
The GUID of the parent device if this device is a sub-device.
Property type: Attribute
No
device.raidLevel
Enumeration
The RAID level of the device if the value of device.cspDeviceType is "RAID".
Property type: Element
Valid values:
  • RAID0
  • RAID1
No
device.subDevices
Container
The array of sub-devices that this device contains.
Property type: Element
No
device.info
String
The information of this device on CSP.
Property type: Attribute
No
device.lastModified
DateTime
The date and time this device was last modified.
Property type: Attribute
Valid value: a date and time in the format "yyyy-MM-ddThh:mm:ss.sss, UTC"
No
device.OS
Container: OperatingSystem
The operating system the device belongs to.
Property type: Element
No
device.preserveData
String
Indicates whether the data in the device will be kept or deleted during the encryption.
Valid values:
  • yes:
  • no:
Property type: Attribute
  
device.fileSystem
String
The file system of the device.
Property type: Element
Note
Note
You must specify this parameter if device.preserveData is set to no.
No
device.configured
Boolean
Indicates whether the device is configured.
Property type: Attribute
Valid values:
  • True: device is configured.
  • False: device is not configured.
No
device.writeaccess
Boolean
Indicates whether the device has Read/Write capabilities.
Property type: Attribute
Valid values:
  • True: device has Read/Write capabilities.
  • False: device is Read Only.
No
device.provisionState
Enumeration
The provision state of this device.
Property type: Attribute
Valid values:
  • None: device has never been provisioned.
  • Pending: device is waiting for provisioning.
  • Encrypting: device is being provisioned.
  • Unknown: cannot connect to device.
  • Complete: device is provisioned.
  • Stopped: device is in the process of provisioning but has been stopped.
  • Failed: device encountered an error during provisioning.
No
device.provisionProgress
Integer
The percent completion of the device provisioning (encryption) process.
Property type: Attribute
Valid value: an integer 0-100
No
device.deviceStatus
Container: DeviceStatus
The status of the device.
Property type: Element
Valid values:
  • NotConfigured: the device is not currently in use and not yet encrypted. Essential configuration information such as operating system, file system, and mount point have not yet been specified.
  • Configured: the device is attached to an instance but the encryption key has not yet been given. Essential configuration information such as operating system, file system, and mount point have been specified.
  • EncryptionPending: the device is already configured and attached to a virtual machine instance. SecureCloud is ready to approve the requested key and encrypt the storage device.
  • Encrypting: SecureCloud is in the process of encrypting the requested device.
  • EncryptionError: provisioning for the device has failed. SecureCloud has encountered a problem during provisioning.
  • Undetected: the device is removed from CSP.
  • Encrypted: the device is provisioned and ready to use.
  • InUse: the device is configured, mounted, encrypted, and being accessed by the requesting instance of the machine image.
No
device.detachable
Boolean
Indicates whether the device is detachable from host.
Property type: Attribute
Valid values:
  • True: device can be re-assigned to another image.
  • False: device is bound to a specific image.
No
device.deviceIndex
Integer
The index of the device in the host virtual machine.
Property type: Attribute
No
device.EncryptedName
String
The name of the device after encryption.
Property type: Attribute
No
device.PartitionType
Container: PartitionType
The style of partition file formatting.
Property type: Element
Valid values:
  • mbr: the disk uses the Master Boot Record (MBR) partitioning scheme.
  • gpt: the disk uses the GUID Partition Table (TPT) partitioning scheme.
  • none: the disk uses no partitioning scheme.
No
device.PartitionList
Container: PartitionList
The array of partitions for a given device.
Property type: Attribute
No
device.Provider
Container: Provider
The Cloud Service Provider (CSP) which the virtual machine belongs to.
Property type: Element
No
device.Image
Container: Image
The container of information about a virtual machine image.
Property type: Attribute
No
device.description
String
The description of the device.
Property type: Element
Valid value: any string of 1-360 characters
No
device.volume
Container
The volume-related attributes of the device.
Property type: Element
No
volume.mountPoint
String
The mount point of the device.
Property type: Element
Note
Note
You must specify this parameter if device.preserveData is set to no.
Yes
volume.size
String
The volume size of the device.
Property type: Attribute
No
device.connections
Container
The maximum concurrent connections to the device.
Property type: Element
No
connections.read
Integer
The maximum concurrent read connections to the device.
Property type: Attribute
Yes
connections.write
Integer
The maximum concurrent write connections to the device.
Property type: Attribute
Yes
device.SecurityGroup
Container: SecurityGroup
The container for security group policy information.
Property type: Element
No
device.keyGen
Container
The encryption key information of the device.
Property type: Element
No
keyGen.keySize
Integer
The key size of the encryption device.
Property type: Attribute
Yes
keyGen.Cipher
Container: Cipher
The cipher algorithm used in encryption and decryption.
Property type: Element
Valid values:
  • AES
  • DES
  • 3DES
  • Blowfish
  • XOR
Yes
keyGen.blockSize
Integer
The block size of the encryption key.
Property type: Attribute
No
keyGen.KeyManagementType
Container: KeyManagementType
The key management type.
Property type: Element
Valid values:
  • LUKS
  • DataArmor
  • None
No
keyGen.IV
Container: IV
The initialization vector (IV) of the encryption key
Property type: Element
Valid values:
  • ESSIV:SHA256
  • Plain
  • Sector32
No
keyGen.Hash
Container: Hash
The cryptographic hash function of the encryption key.
Property type: Element
Valid values:
  • SHA-1
  • SHA-224
  • SHA-256
  • SHA-384
  • SHA-512
No
keyGen.Mode
Container: Mode
The key generation mode.
Property type: Element
Valid values:
  • CBC
  • CFB
  • XTS
No
keyGen.StoredOn
Container: StoredOn
The storage location of the encryption key.
Property type: Element
Valid values:
  • SecureCloud Server
  • Key Management Interoperability Protocol (KMIP) Server
No
keyGen.PassPhrase
String
The passphrase of the encryption key
Property type: Attribute
No
keyGen.kmipInfo
Container
The KMIP information of the encryption key, if the key is stored on the KMIP server.
Property type: Element
No
kmipInfo.serverHostname
String
The server hostname of the KMIP server.
Property type: Attribute
Yes
kmipInfo.serverPort
Integer
The server port of the KMIP server.
Property type: Attribute
Yes
kmipInfo.serverActive
Boolean
The active state of the KMIP server.
Property type: Attribute
Yes
kmipInfo.serverEnabled
Boolean
Indicates whether the KMIP server is enabled.
Property type: Attribute
Yes
kmipInfo.keyGUID
String
The GUID of the KMIP encryption key.
Property type: Attribute
Yes
kmipInfo.serverCertificate
String
The certificate of the KMIP server.
Property type: Attribute
Yes
kmipInfo.serverCertificateHash
String
The certificate hash of the KMIP server.
Property type: Attribute
Yes
kmipInfo.clientCertificate
String
The certificate of the KMIP client.
Property type: Attribute
Yes
kmipInfo.clientCertificateHash
String
The certificate hash of the KMIP client.
Property type: Attribute
Yes
kmipInfo.clientKey
String
The key of the KMIP client.
Property type: Attribute
Yes
kmipInfo.clientKeyHash
String
The key hash of the KMIP client.
Property type: Attribute
Yes
kmipInfo.clientKeyPassword
String
The key password of the KMIP client.
Property type: Attribute
Yes