Test Search vSphere Web Services API
|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - ListView(vim.view.ListView)
- Returned by
- CreateListView, CreateListViewFromView
- Extends
- ManagedObjectView
- See also
- View
- Since
- VI API 2.5
Managed Object Description
The ListView managed object provides access to updates on a specific set of objects. You can use a ListView with a PropertyCollector method to retrieve data or receive notification of changes. For information about using views with the PropertyCollector, see the description of ViewManager.When you invoke the CreateListView method, you specify a list of objects. The View list always represents the current configuration of the virtual environment and reflects any subsequent changes that occur.
Properties
| Name | Type | Description |
|---|---|---|
| None | ||
| Properties inherited from ManagedObjectView | ||
| view | ||
| Properties inherited from View | ||
| None | ||
Methods
| Methods defined in this Managed Object |
|---|
| ModifyListView, ResetListView, ResetListViewFromView |
| Methods inherited from ManagedObjectView |
| None |
| Methods inherited from View |
| DestroyView |
ModifyListView(modify)
Modify the list by giving a delta of entities to add and entities to remove.May partially succeed if some objects could not be resolved. The operation will still succeed for all objects 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 ListView used to make the method call. |
| add* P | ManagedObjectReference[] |
Optional list of objects to add to the view.
Since VI API 2.5 |
| remove* P | ManagedObjectReference[] |
Optional list of objects to remove from the view.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference[] | A list containing any objects in 'add' that 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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
ResetListView(reset)
Replaces the list with an entirely new set of objects. If the entire set is changing, this is less data to send than a delta.May partially succeed if some objects could not be resolved. The operation will still succeed for all objects which could be resolved, and the list of those which failed is as the result.
- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ListView used to make the method call. |
| obj* P | ManagedObjectReference[] |
The new list of objects.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference[] | A list containing any objects in 'obj' that 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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
ResetListViewFromView(resetFromView)
Replaces the list with the set of objects in a given view.- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ListView used to make the method call. |
| view | ManagedObjectReference
to a View |
The view to copy objects from.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| None | |
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 | |
Show WSDL type definition
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |