openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/host/VFlashManager.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

4.5 KiB
Raw Blame History

vim.host.VFlashManager

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

since

vSphere API 5.5

Attributes

vFlashConfigInfo (vim.host.VFlashManager.VFlashConfigInfo):

Host vFlash configuration information.

Methods

ConfigureVFlashResourceEx(devicePath):

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.

Privilege:

Host.Config.Storage

Args:
devicePath (str, optional):

An array of device path names that identify disks. See ScsiDisk .

Returns:

vim.Task:

Raises:

vim.fault.HostConfigFault:

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.

HostConfigureVFlashResource(spec):

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

Privilege:

Host.Config.Storage

Args:
spec (vim.host.VFlashManager.VFlashResourceConfigSpec):

the vFlash resource specification.

Returns:

None

Raises:

vim.fault.HostConfigFault:

If vFlash resource cannot be configured on the host

vim.fault.ResourceInUse:

The contained VFFS volume is being used.

HostRemoveVFlashResource():

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

Privilege:

Host.Config.Storage

Args:

Returns:

None

Raises:

vim.fault.NotFound:

If vFlash resource is not configured or the contained VFFS volume cannot be found on the host.

vim.fault.HostConfigFault:

If vFlash resource or the contained VFFS volume cannot be removed from the host.

vim.fault.ResourceInUse:

The contained VFFS volume is being used.

HostConfigVFlashCache(spec):

Configurate vFlash cache on the host.

Privilege:

Host.Config.AdvancedConfig

Args:
spec (vim.host.VFlashManager.VFlashCacheConfigSpec):

Specification for host cache configuration.

Returns:

None

Raises:

vim.fault.HostConfigFault:

If the swap cache cannot be configured on the host.

vim.fault.InaccessibleVFlashSource:

vFlash resource is not accessible.

vim.fault.ResourceInUse:

The contained VFFS volume is being used.

HostGetVFlashModuleDefaultConfig(vFlashModule):

Retrieve the default supported configuration for a given vFlash module

Privilege:

Host.Config.AdvancedConfig

Args:
vFlashModule (str):

Name of the vFlash module

Returns:
vim.vm.device.VirtualDisk.VFlashCacheConfigInfo:

The supported default vFlash cache configuration

Raises:

vim.fault.NotFound:

If vFlash resource is not configured or the contained VFFS volume cannot be found on the host.

vim.fault.HostConfigFault:

If the default vFlash module configuration option cannot be retrieved.