# Managed Object - HostVFlashManager(vim.host.VFlashManager)

Property of
  HostConfigManager
See also
  HostVFlashManagerVFlashCacheConfigSpec, HostVFlashManagerVFlashConfigInfo, HostVFlashManagerVFlashResourceConfigSpec, HostVFlashResourceConfigurationResult, VirtualDiskVFlashCacheConfigInfo
Since
  vSphere API 5.5

## Managed Object Description

The VFlash Manager object is used to configure vFlash resource and vFlash cache on the ESX host.

Properties

Name | Type | Description
--- | --- | ---
vFlashConfigInfo* | HostVFlashManagerVFlashConfigInfo | Host vFlash configuration information.

*May not be present

Methods

Methods defined in this Managed Object
ConfigureVFlashResourceEx_Task, HostConfigureVFlashResource, HostConfigVFlashCache, HostGetVFlashModuleDefaultConfig, HostRemoveVFlashResource

# ConfigureVFlashResourceEx_Task(configureVFlashResourceEx)

Configure vFlash resource on a list of SSD disks. If the host does not have a VFFS volume, host will format the volume first and then extend the volume on the rest of the SSDs; otherwise host will extend the existing VFFS volume on the passed SSDs. Finally host will configure the vFlash resource on the VFFS volume.

It will return HostVFlashResourceConfigurationResult describing success or failure associated with each device.

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVFlashManager used to make the method call.
devicePath* P | xsd:string[] | An array of device path names that identify disks. See ScsiDisk. Since vSphere API 5.5

*Need not be set P Required privilege: devicePath

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask | This method returns a Task object with which to monitor the operation. The result property in the Task contains HostVFlashResourceConfigurationResult describing success or failure associated with each device.

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if batch operation fails on the host. Because the returned VFlashResourceConfigurationResult contains the configuration success or fault for each device, as of vSphere API 5.x, we won't throw fault when batch operation fails.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# HostConfigureVFlashResource(configureVFlashResource)

Configure vFlash resource on the host by attaching to a backend VFFS volume.

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVFlashManager used to make the method call.
spec P | HostVFlashManagerVFlashResourceConfigSpec | the vFlash resource specification. Since vSphere API 5.5

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if vFlash resource cannot be configured on the host
ResourceInUse | The contained VFFS volume is being used.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostConfigureVFlashResource" type="sms:HostConfigureVFlashResourceRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostConfigureVFlashResourceResponse"> <complexType/> </element>

# HostConfigVFlashCache(configureHostVFlashCache)

Configure vFlash cache on the host.

Required Privileges
  Host.Config.AdvancedConfig

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVFlashManager used to make the method call.
spec P | HostVFlashManagerVFlashCacheConfigSpec | Specification for host cache configuration. Since vSphere API 5.5

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the swap cache cannot be configured on the host.
InaccessibleVFlashSource | vFlash resource is not accessible.
ResourceInUse | The contained VFFS volume is being used.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostConfigVFlashCache" type="sms:HostConfigVFlashCacheRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostConfigVFlashCacheResponse"> <complexType/> </element>

# HostGetVFlashModuleDefaultConfig(getVFlashModuleDefaultConfig)

Retrieve the default supported configuration for a given vFlash module

Required Privileges
  Host.Config.AdvancedConfig

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVFlashManager used to make the method call.
vFlashModule P | xsd:string | Name of the vFlash module Since vSphere API 5.5

P Required privilege: vFlashModule

Return Value

Type | Description
--- | ---
VirtualDiskVFlashCacheConfigInfo | The supported default vFlash cache configuration

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the default vFlash module configuration option cannot be retrieved.
NotFound | Thrown if vFlash resource is not configured or the contained VFFS volume cannot be found on the host.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostGetVFlashModuleDefaultConfig" type="sms:HostGetVFlashModuleDefaultConfigRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostGetVFlashModuleDefaultConfigResponse"> <complexType> <sequence> <element name="returnval" type="sms:VirtualDiskVFlashCacheConfigInfo"/> </sequence> </complexType> </element>

# HostRemoveVFlashResource(removeVFlashResource)

Remove vFlash resource on the host by destroying the contained VFFS volume.

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVFlashManager used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if vFlash resource or the contained VFFS volume cannot be removed from the host.
NotFound | Thrown if vFlash resource is not configured or the contained VFFS volume cannot be found on the host.
ResourceInUse | The contained VFFS volume is being used.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostRemoveVFlashResource" type="sms:HostRemoveVFlashResourceRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="HostRemoveVFlashResourceResponse"> <complexType/> </element>