Host Storage System Format Vmfs
Formats a new VMFS on a disk partition.
Required privileges: Host.Config.Storage
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostStorageSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"createSpec": {
"extent": {
"diskName": "string",
"partition": 0
},
"majorVersion": 0,
"volumeName": "string"
}
}{
"createSpec": {
"_typeName": "string",
"extent": {
"_typeName": "string",
"diskName": "string",
"partition": 0
},
"blockSizeMb": 0,
"majorVersion": 0,
"volumeName": "string",
"blockSize": 0,
"unmapGranularity": 0,
"unmapPriority": "string",
"unmapBandwidthSpec": {
"_typeName": "string",
"policy": "string",
"fixedValue": 0,
"dynamicMin": 0,
"dynamicMax": 0
}
}
}This data object type describes the VMware File System (VMFS) creation specification.
Once created, these properties for the most part cannot be changed. There are a few exceptions.
A data object that represents the VMFS file system.
{
"_typeName": "string",
"type": "string",
"name": "string",
"capacity": 0,
"blockSizeMb": 0,
"blockSize": 0,
"unmapGranularity": 0,
"unmapPriority": "string",
"unmapBandwidthSpec": {
"_typeName": "string",
"policy": "string",
"fixedValue": 0,
"dynamicMin": 0,
"dynamicMax": 0
},
"maxBlocks": 0,
"majorVersion": 0,
"version": "string",
"uuid": "string",
"extent": [
{
"_typeName": "string",
"diskName": "string",
"partition": 0
}
],
"vmfsUpgradable": false,
"forceMountedInfo": {
"_typeName": "string",
"persist": false,
"mounted": false
},
"ssd": false,
"local": false,
"scsiDiskType": "string"
}Deprecated as of vSphere API 6.5, use HostVmfsVolume.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.
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.
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 HostVmfsVolume.blockSize. This property cannot be changed after a VMFS volume is created.
VMFS unmap reclaims unused storage space.
This property determines the processing rate of unmaps. See HostVmfsVolumeUnmapPriorityEnum 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 HostStorageSystem.UpdateVmfsUnmapPriority.
VMFS unmap reclaims unused storage space.
This data object type describes the specification of VMFS unmap bandwidth.
Maximum number of blocks.
Determines maximum file size along with blockSize. See information about the blockSize.
Major version number of VMFS.
Version string.
Contains major and minor version numbers.
The universally unique identifier assigned to VMFS.
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.
Can the filesystem be upgraded to a newer version.
See also HostStorageSystem.UpgradeVmfs.
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 keep the original Uuid and mount it on the host, it will have 'forceMounted' flag and 'forceMountedInfo' set. 'ForceMountedInfo' provides additional information specific to user-mounted VmfsVolume.
Indicates whether the volume is SSD backed.
If unset, the information whether the volume is SSD backed is unknown.
Indicates whether the volume is backed by local disk.
If unset, the information of the volume is local-disk backed is unknown.
The type of disk drives.
See ScsiDiskTypeEnum for supported types. If unset, the default disk drive type is native512.
InvalidArgument: if VMFS version specified is not 2 or 3, if blocksize, lock mode, or volume label are invalid, the partition does not exist or is of an invalid type.
AlreadyExists: if the volume name is already being used by another volume on the host.
HostConfigFault: for all other configuration failures.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}