Data Object - CnsVolumeAttachDetachSpec(vim.cns.VolumeAttachDetachSpec)

Parameter to: CnsAttachVolume, CnsDetachVolume
Extends: DynamicData
See also: CnsVolumeId, VirtualMachine
Since: vSAN 6.7U3

Data Object Description

Data object for specifications for volume attach/detach operations.

Properties

Name	Type	Description
backingTypeName*	xsd:string	Specifies the file backing type for the volume. Valid values are defined in CnsVolumeBackingType For dynamically provisioned volumes: If not provided, defaults to VirtualDiskFlatVer2BackingInfo If provided, the specified backing type will be used. For statically provisioned volumes: This field is required. If not provided, a CnsFault will be thrown. *Since* 9.1.0.0
controllerKey*	xsd:int	Key of the controller the disk will connect to. It can be unset if there is only one controller (SCSI/SATA/NVME) with the available slot in the virtual machine. If there are multiple SCSI/SATA/NVME controllers available, user must specify the controller; if there is no available controllers, a MissingController fault will be thrown. *Since* 9.1.0.0
diskMode*	xsd:string	The disk persistence mode. Valid modes are vim.vm.device.VirtualDiskOption.DiskMode#persistent vim.vm.device.VirtualDiskOption.DiskMode#independent_persistent vim.vm.device.VirtualDiskOption.DiskMode#independent_nonpersistent vim.vm.device.VirtualDiskOption.DiskMode#nonpersistent vim.vm.device.VirtualDiskOption.DiskMode#undoable vim.vm.device.VirtualDiskOption.DiskMode#append When unset, default mode is persistent(that also means dependant persistent to CNS) see VirtualDiskMode *Since* 9.1.0.0
sharing*	xsd:string	The sharing mode of the virtual disk. Valid values are vim.vm.device.VirtualDisk.Sharing#sharingNone vim.vm.device.VirtualDisk.Sharing#sharingMultiWriter When unset, default value is sharingNone See VirtualDiskSharing *Since* 9.1.0.0
unitNumber*	xsd:int	The unit number of the disk to be attached on its controller. If unset, the next free slot on the specified controller or on the only available controller will be assigned to the attached disk. *Since* 9.1.0.0
vm	ManagedObjectReference to a VirtualMachine	VirtualMachine to which this volume needs to be attached to.
volumeEncrypted*	xsd:boolean	Indicates whether the volume is encrypted. When set to true, the volume is encrypted and vpxd API AttachVStorageObject_Task will be called for cryptographic key handling during batch attach operations. When set to false, the volume is not encrypted and vpxd API AttachVStorageObject_Task call will be skipped. When unset, regardless of the volume encryption status, vpxd API AttachVStorageObject_Task will be called to determine the volume encryption status and perform cryptographic key handling if the volume is encrypted. Note: AttachVStorageObject_Task call might impact performance. *Since* 9.1.0.0
volumeId	CnsVolumeId	Unique identifier and datastore information for the volume.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CnsVolumeAttachDetachSpec">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="volumeId" type="vsan:CnsVolumeId"/>
                     <element name="vm" type="vsan:ManagedObjectReference"/>
                     <element name="diskMode" type="xsd:string" minOccurs="0"/>
                     <element name="sharing" type="xsd:string" minOccurs="0"/>
                     <element name="controllerKey" type="xsd:int" minOccurs="0"/>
                     <element name="unitNumber" type="xsd:int" minOccurs="0"/>
                     <element name="backingTypeName" type="xsd:string" minOccurs="0"/>
                     <element name="volumeEncrypted" type="xsd:boolean" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSAN Management API

Data Object - CnsVolumeAttachDetachSpec(vim.cns.VolumeAttachDetachSpec)

Data Object Description