15f7be9a52
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
2.1 KiB
vim.OvfManager.CreateDescriptorParams
Collection of parameters for createDescriptor
- extends
- since
- Attributes:
-
ovfFiles (vim.OvfManager.OvfFile, optional):
Contains information about the files of the entity, if they have already been downloaded. Needed to construct the References section of the descriptor.OvfFile is a positive list of files to include in the export. An Empty list will do no filtering.
name (str, optional):
The ovf:id to use for the top-level OVF Entity. If unset, the entity's product name is used if available. Otherwise, the VI entity name is used.
description (str, optional):
The contents of the Annontation section of the top-level OVF Entity. If unset, any existing annotation on the entity is left unchanged.
includeImageFiles (bool, optional):
Controls whether attached image files should be included in the descriptor. This applies to image files attached to VirtualCdrom and VirtualFloppy.
exportOption (str, optional):
An optional argument for modifying the export process. The option is used to control what extra information that will be included in the OVF descriptor.To get a list of supported keywords see ovfExportOption . Unknown options will be ignored by the server.
snapshot (vim.vm.Snapshot, optional):
Snapshot reference from which the OVF descriptor should be based.If this parameter is set, the OVF descriptor is based off the snapshot point. This means that the OVF descriptor will have the same configuration as the virtual machine at the time the snapshot was taken.The snapshot must be belong to the specified ManagedEntity in the createDescriptor call.