Files

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.0 KiB

Raw Blame History

vim.view.InventoryView

The InventoryView managed object provides a means of browsing the inventory and tracking changes to open folders. This managed object is particularly useful for UI clients that display a tree-based navigation panel of the inventory. InventoryView maintains the view list of managed object references to inventory objects. When you create an inventory view ( CreateInventoryView ), the server initializes the view's object list with a single folder - the root folder. InventoryView provides methods to open and close folders in the inventory. Use these methods to add and subtract objects from the view list. Use the InventoryView together with the PropertyCollector to manage the data resulting from OpenInventoryViewFolder and CloseInventoryViewFolder methods. By using the PropertyCollector , you have access to the modifications to the view, rather than processing the entire view list.For example, you might use the following sequence of operations with an InventoryView and the PropertyCollector :

Create an

InventoryView

.

Create a filter specification for the

PropertyCollector

.

Use the

InventoryView

as the starting object in the

ObjectSpec

for the filter.

Use a set of

TraversalSpec

data objects to identify paths in possible inventory configurations.

Use the

PropertySpec

to identify object properties for retrieval.

Use either the

CheckForUpdates

or

WaitForUpdates

method to obtain

InventoryView

modifications. Both methods return an

UpdateSet

object that describes the changes returned by the

PropertyCollector

.

Call the

OpenInventoryViewFolder

or

method

.

extends: vim.view.ManagedObjectView
since: VI API 2.5

Attributes

Methods

OpenInventoryViewFolder(entity):

Adds the child objects of a given managed entity to the view.If a Datacenter is returned as a child, the implicit virtual machine folder and host folder objects are also returned. If a ComputeResource is returned, the implicit root ResourcePool and HostSystem objects are also returned.May partially succeed if some entities could not be resolved. The operation will still succeed for all entities which could be resolved, and the list of those which failed is returned as the result.

Privilege:

Args:

entity (vim.ManagedEntity):: An array of managed object references. Each array entry is a reference to an entity to expand. Expands each entity in the order given. If an entity is not in the current view, expands the view as needed.

Returns:

vim.ManagedEntity:: A list containing any entities in the argument could not be resolved.

CloseInventoryViewFolder(entity):

Notify the server that folder(s) have been closed, and changes for all its contained objects should no longer be sent. The associated child objects are removed from the view. The containers themselves will still be retained as open objects until their parent is closed.May partially succeed if some entities could not be resolved. The operation will still succeed for all entities that could be resolved, and the list of those that failed is returned as the result.