| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
A View is a mechanism that supports selection of objects on the server and subsequently, access to those objects. Views can simplify the task of retrieving data from the server. When you use a view, you can use a single invocation of a PropertyCollector method to retrieve data or receive notification of changes instead of multiple invocations involving multiple filter specifications. A view exists until you destroy it or until the end of the session.
The ViewManager supports the following views:
For example, you might use the following sequence of operations to get the names of all the virtual machines on a server:
Properties
Name | Type | Description |
---|---|---|
viewList* P | ManagedObjectReference[]
to a View[] |
An array of view references. Each array entry is a managed object reference
to a view created by this ViewManager.
|
Methods
Methods defined in this Managed Object |
---|
CreateContainerView, CreateInventoryView, CreateListView, CreateListViewFromView |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ViewManager used to make the method call. |
container P | ManagedObjectReference
to a ManagedEntity |
A reference to an instance of a Folder,
Datacenter, ComputeResource,
ResourcePool, or HostSystem object.
|
type* | xsd:string[] |
An optional list of managed entity types. The server
associates only objects of the specified type(s) with the view.
If you specify an empty array, the server uses all types.
|
recursive | xsd:boolean |
Whether to include only the immediate children of the
container instance, or to include additional objects by
following paths beyond the immediate children.
When recursive is false, the list of objects contains only immediate children. When recursive is true, the server populates the list by following references beyond the immediate children (using a child's references, and then references in the resulting objects, and so on). Depending on the container type, the server will use the following properties of the container instance to obtain objects for the view's object list:
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ContainerView |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ViewManager used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a InventoryView |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ViewManager used to make the method call. |
obj* P | ManagedObjectReference[] |
The initial list of objects in the view.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ListView |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ViewManager used to make the method call. |
view | ManagedObjectReference
to a View |
The view that will provide the object list for the
new ListView object.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ListView |
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. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |