Data Object Description

Properties

Name	Type	Description
blockSize*	xsd:int	Block size of VMFS in KB. Determines maximum file size. The maximum number of blocks is typically fixed with each specific version of VMFS. To increase the maximum size of a VMFS file, increase the block size. The minimum block size is 1MB. *Since* vSphere API 6.5
blockSizeMb	xsd:int	Deprecated. As of vSphere API 6.5, use blockSize instead. Block size of VMFS. Determines maximum file size. The maximum number of blocks is typically fixed with each specific version of VMFS. To increase the maximum size of a VMFS file, increase the block size. The minimum block size is 1MB.
extent	HostScsiDiskPartition[]	The list of partition names that comprise this disk's VMFS extents. This property can be accessed via various enclosing objects. In VirtualCenter, where it can be accessed from multiple hosts, the value of this property may differ according to the context in which it is accessed. When accessed from the VmfsDatastoreInfo object, in VirtualCenter, this property reflects the extent information of any one of the hosts visible to the datastore. For a VirtualCenter system which manages ESX Server 2.x and ESX Server 3.x hosts, this extent information is only correlatable across hosts if the extents are exposed on the same adapter on all hosts which can access them. To find the extent names for a specific host, this same property should be accessed via the host's HostFileSystemVolume object, by correlating the uuid of the VMFS datastore in the VmfsDatastoreInfo object to the uuid in the FileSystemVolume object. For a Virtual Center system which manages only ESX Server hosts with versions 4.0 onwards , this extent information is correlatable across hosts, irrespective of the adapters the extents are exposed on.
forceMountedInfo*	HostForceMountedInfo	Information about 'forceMounted' VmfsVolume. When the system detects a copy of a VmfsVolume, it will not be auto-mounted on the host and it will be detected as 'UnresolvedVmfsVolume'. If user decides to 'forceMount' the VmfsVolume on the host, forceMountedInfo will be populated. It will not be set for automounted VMFS volumes. *Since* vSphere API 4.0
local*	xsd:boolean	Indicates whether the volume is backed by local disk. If unset, the information of the volume is local-disk backed is unknown. *Since* vSphere API 5.5
majorVersion	xsd:int	Major version number of VMFS.
maxBlocks	xsd:int	Maximum number of blocks. Determines maximum file size along with blockSize. See information about the blockSize.
scsiDiskType*	xsd:string	The type of disk drives. See ScsiDiskType for supported types. If unset, the default disk drive type is native512. *Since* vSphere API 6.5
ssd*	xsd:boolean	Indicates whether the volume is SSD backed. If unset, the information whether the volume is SSD backed is unknown. *Since* vSphere API 5.0
unmapBandwidthSpec*	VmfsUnmapBandwidthSpec	VMFS unmap bandwidth related specification. See VmfsUnmapBandwidthSpec for detail. *Since* vSphere API 6.7
unmapGranularity*	xsd:int	VMFS unmap reclaims unused storage space. This property determines the granularity of unmap operations. The unit is KB. If not specified, the default value is the same as the block size of VMFS blockSize. This property cannot be changed after a VMFS volume is created. *Since* vSphere API 6.5
unmapPriority*	xsd:string	VMFS unmap reclaims unused storage space. This property determines the processing rate of unmaps. See HostVmfsVolumeUnmapPriority for supported values. If not specified, the default value is low, which means unmap is processed at low rate. This property can be updated by calling UpdateVmfsUnmapPriority. *Since* vSphere API 6.5
uuid	xsd:string	The universally unique identifier assigned to VMFS.
version	xsd:string	Version string. Contains major and minor version numbers.
vmfsUpgradable	xsd:boolean	Can the filesystem be upgraded to a newer version. See UpgradeVmfs
Properties inherited from HostFileSystemVolume
capacity, name, type
Properties inherited from DynamicData
None

Name

Type

Description

blockSize*

xsd:int

Block size of VMFS in KB. Determines maximum file size. The maximum number of blocks is typically fixed with each specific version of VMFS. To increase the maximum size of a VMFS file, increase the block size.

The minimum block size is 1MB.

Since vSphere API 6.5

blockSizeMb

xsd:int

Deprecated. As of vSphere API 6.5, use blockSize instead.

Block size of VMFS. Determines maximum file size. The maximum number of blocks is typically fixed with each specific version of VMFS. To increase the maximum size of a VMFS file, increase the block size.

The minimum block size is 1MB.

extent

HostScsiDiskPartition[]

The list of partition names that comprise this disk's VMFS extents.

This property can be accessed via various enclosing objects. In VirtualCenter, where it can be accessed from multiple hosts, the value of this property may differ according to the context in which it is accessed. When accessed from the VmfsDatastoreInfo object, in VirtualCenter, this property reflects the extent information of any one of the hosts visible to the datastore.

For a VirtualCenter system which manages ESX Server 2.x and ESX Server 3.x hosts, this extent information is only correlatable across hosts if the extents are exposed on the same adapter on all hosts which can access them. To find the extent names for a specific host, this same property should be accessed via the host's HostFileSystemVolume object, by correlating the uuid of the VMFS datastore in the VmfsDatastoreInfo object to the uuid in the FileSystemVolume object.

For a Virtual Center system which manages only ESX Server hosts with versions 4.0 onwards , this extent information is correlatable across hosts, irrespective of the adapters the extents are exposed on.

forceMountedInfo*

HostForceMountedInfo

Information about 'forceMounted' VmfsVolume. When the system detects a copy of a VmfsVolume, it will not be auto-mounted on the host and it will be detected as 'UnresolvedVmfsVolume'. If user decides to 'forceMount' the VmfsVolume on the host, forceMountedInfo will be populated. It will not be set for automounted VMFS volumes.

Since vSphere API 4.0

local*

xsd:boolean

Indicates whether the volume is backed by local disk. If unset, the information of the volume is local-disk backed is unknown.

Since vSphere API 5.5

majorVersion

xsd:int

Major version number of VMFS.

maxBlocks

xsd:int

Maximum number of blocks. Determines maximum file size along with blockSize. See information about the blockSize.

scsiDiskType*

xsd:string

The type of disk drives. See ScsiDiskType for supported types. If unset, the default disk drive type is native512.

Since vSphere API 6.5

ssd*

xsd:boolean

Indicates whether the volume is SSD backed. If unset, the information whether the volume is SSD backed is unknown.

Since vSphere API 5.0

unmapBandwidthSpec*

VmfsUnmapBandwidthSpec

VMFS unmap bandwidth related specification. See VmfsUnmapBandwidthSpec for detail.

Since vSphere API 6.7

unmapGranularity*

xsd:int

VMFS unmap reclaims unused storage space. This property determines the granularity of unmap operations. The unit is KB. If not specified, the default value is the same as the block size of VMFS blockSize. This property cannot be changed after a VMFS volume is created.

Since vSphere API 6.5

unmapPriority*

xsd:string

VMFS unmap reclaims unused storage space. This property determines the processing rate of unmaps. See HostVmfsVolumeUnmapPriority for supported values. If not specified, the default value is low, which means unmap is processed at low rate. This property can be updated by calling UpdateVmfsUnmapPriority.

Since vSphere API 6.5

uuid

xsd:string

The universally unique identifier assigned to VMFS.

version

xsd:string

Version string. Contains major and minor version numbers.

vmfsUpgradable

xsd:boolean

Can the filesystem be upgraded to a newer version.
See UpgradeVmfs

Properties inherited from HostFileSystemVolume

capacity, name, type

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostVmfsVolume">
            <complexContent>
               <extension base="pbm:HostFileSystemVolume">
                  <sequence>
                     <element name="blockSizeMb" type="xsd:int"/>
                     <element name="blockSize" type="xsd:int" minOccurs="0"/>
                     <element name="unmapGranularity" type="xsd:int" minOccurs="0"/>
                     <element name="unmapPriority" type="xsd:string" minOccurs="0"/>
                     <element name="unmapBandwidthSpec" type="pbm:VmfsUnmapBandwidthSpec" minOccurs="0"/>
                     <element name="maxBlocks" type="xsd:int"/>
                     <element name="majorVersion" type="xsd:int"/>
                     <element name="version" type="xsd:string"/>
                     <element name="uuid" type="xsd:string"/>
                     <element name="extent" type="pbm:HostScsiDiskPartition" maxOccurs="unbounded"/>
                     <element name="vmfsUpgradable" type="xsd:boolean"/>
                     <element name="forceMountedInfo" type="pbm:HostForceMountedInfo" minOccurs="0"/>
                     <element name="ssd" type="xsd:boolean" minOccurs="0"/>
                     <element name="local" type="xsd:boolean" minOccurs="0"/>
                     <element name="scsiDiskType" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - HostVmfsVolume(vim.host.VmfsVolume)

Data Object Description