Files
deb-python-pyvmomi/docs/vim/vm/FileInfo.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

1.8 KiB

vim.vm.FileInfo

The FileInfo data object type contains the locations of virtual machine files other than the virtual disk files. The configurable parameters are all in the FileInfo object.The object also contains a FileLayout object that returns a complete list of additional files that makes up the virtual machine configuration. This is a read-only structure and is returned when the configuration is read. This is ignored during configuration and can be left out.

extends

vmodl.DynamicData

Attributes:

vmPathName (str, optional):

Path name to the configuration file for the virtual machine, e.g., the .vmx file. This also implicitly defines the configuration directory.

snapshotDirectory (str, optional):

Path name of the directory that holds suspend and snapshot files belonging to the virtual machine. Prior to vSphere 5.0, this directory also holds snapshot redo files. Starting with vSphere 5.0, the redo files will stay in the same directory as the snapshotted disk, thus this directory will no longer hold the snapshot redo files.This path name defaults to the same directory as the configuration file.ESX Server requires this to indicate a VMFS volume or NAS volume (for ESX Server 3). In case the configuration file is not stored on VMFS or NAS, this property must be set explicitly.

suspendDirectory (str, optional):

Some products allow the suspend directory to be different than the snapshot directory. On products where this is not possible, setting of this property is ignored.

logDirectory (str, optional):

Directory to store the log files for the virtual machine. If not specified, this defaults to the same directory as the configuration file,