openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/CustomizationSpecManager.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

5.6 KiB
Raw Blame History

vim.CustomizationSpecManager

The CustomizationSpecManager managed object is used to manage customization specifications stored on the VirtualCenter server.

Attributes

info (vim.CustomizationSpecInfo):
privilege: VirtualMachine.Provisioning.ReadCustSpecs

Gets a list of information on available specifications.

encryptionKey (int):
privilege: System.View

Gets a binary public encryption key that can be used to encrypt passwords in stored specifications.

Methods

DoesCustomizationSpecExist(name):

Whether or not a specification exists.

Privilege:

VirtualMachine.Provisioning.ReadCustSpecs

Args:

name (str):

Returns:

bool:

GetCustomizationSpec(name):

Obtains a specification for the given name.

Privilege:

VirtualMachine.Provisioning.ReadCustSpecs

Args:
name (str):

Unique name identifying the requested customization specification.

Returns:

vim.CustomizationSpecItem:

Raises:

vim.fault.NotFound:

vim.fault.NotFound

CreateCustomizationSpec(item):

Creates a new specification.

Privilege:

VirtualMachine.Provisioning.ModifyCustSpecs

Args:

item (vim.CustomizationSpecItem):

Returns:

None

Raises:

vim.fault.CustomizationFault:

vim.fault.CustomizationFault

vim.fault.AlreadyExists:

vim.fault.AlreadyExists

vim.fault.CannotDecryptPasswords:

vim.fault.CannotDecryptPasswords

OverwriteCustomizationSpec(item):

Overwrites an existing specification, possibly after retrieving (by using 'get') and editing it. If, based on the item's changeVersion value, the overwrite process detects that the specification has changed since its retrieval, then the API uses the SpecModified exception to warn the client that he might overwrite another client's change.

Privilege:

VirtualMachine.Provisioning.ModifyCustSpecs

Args:

item (vim.CustomizationSpecItem):

Returns:

None

Raises:

vim.fault.CustomizationFault:

vim.fault.CustomizationFault

vim.fault.NotFound:

vim.fault.NotFound

vim.fault.ConcurrentAccess:

vim.fault.ConcurrentAccess

vim.fault.CannotDecryptPasswords:

vim.fault.CannotDecryptPasswords

DeleteCustomizationSpec(name):

Deletes a specification.

Privilege:

VirtualMachine.Provisioning.ModifyCustSpecs

Args:

name (str):

Returns:

None

Raises:

vim.fault.NotFound:

vim.fault.NotFound

DuplicateCustomizationSpec(name, newName):

Duplicates a specification.

Privilege:

VirtualMachine.Provisioning.ModifyCustSpecs

Args:

name (str):

newName (str):

Returns:

None

Raises:

vim.fault.NotFound:

vim.fault.NotFound

vim.fault.AlreadyExists:

vim.fault.AlreadyExists

RenameCustomizationSpec(name, newName):

Renames a specification.

Privilege:

VirtualMachine.Provisioning.ModifyCustSpecs

Args:

name (str):

newName (str):

Returns:

None

Raises:

vim.fault.NotFound:

vim.fault.NotFound

vim.fault.AlreadyExists:

vim.fault.AlreadyExists

CustomizationSpecItemToXml(item):

Converts a specification item to XML text

Privilege:

System.View

Args:

item (vim.CustomizationSpecItem):

Returns:

str:

XmlToCustomizationSpecItem(specItemXml):

Converts an XML string to a specification item

Privilege:

System.View

Args:

specItemXml (str):

Returns:

vim.CustomizationSpecItem:

Raises:

vim.fault.CustomizationFault:

vim.fault.CustomizationFault

CheckCustomizationResources(guestOs):

Validate that required resources are available on the server to customize a particular guest operating system. These would include sysprep for Windows and the debugfs and changefs volume editors for Linux guests.

Privilege:

System.View

Args:
guestOs (str):

Short name from the guest OS descriptor list describing the OS we intend to customize.

Returns:

None

Raises:

vim.fault.CustomizationFault:

vim.fault.CustomizationFault

vim.fault.MissingLinuxCustResources:

vim.fault.MissingLinuxCustResources

vim.fault.MissingWindowsCustResources:

vim.fault.MissingWindowsCustResources

vim.fault.UncustomizableGuest:

vim.fault.UncustomizableGuest