Managed Object - InventoryView

Returned by: CreateInventoryView
Extends: ManagedObjectView
See also: ManagedEntity
Since: VI API 2.5

Managed Object Description

A view convenient for browsing the inventory and tracking changes to open folders.

This managed object is particularly useful for UI clients that want to render a tree-based navigation panel of the inventory.

Properties

Name	Type	Description
None
Properties inherited from ManagedObjectView
view
Properties inherited from View
None

Methods

Methods defined in this Managed Object
CloseInventoryViewFolder, OpenInventoryViewFolder
Methods inherited from ManagedObjectView
None
Methods inherited from View
DestroyView

CloseInventoryViewFolder

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 which could be resolved, and the list of those which failed is returned as the result.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InventoryView used to make the method call.
entity P	ManagedObjectReference[] to a ManagedEntity[]	The entity(ies) to collapse.

P Required privilege: System.View

Return Value

Type	Description
ManagedObjectReference[] to a ManagedEntity[]	A list containing any entities in the argument could not be resolved.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CloseInventoryViewFolder" type="vim25:CloseInventoryViewFolderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CloseInventoryViewFolderResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

OpenInventoryViewFolder

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 HostSystems 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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InventoryView used to make the method call.
entity P	ManagedObjectReference[] to a ManagedEntity[]	The entity(ies) to expand. Expands each entity in the order given. If an entity is not in the current view, expands the view as needed.

P Required privilege: System.View

Return Value

Type	Description
ManagedObjectReference[] to a ManagedEntity[]	A list containing any entities in the argument could not be resolved.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="OpenInventoryViewFolder" type="vim25:OpenInventoryViewFolderRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="OpenInventoryViewFolderResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>