vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - ExtensibleManagedObject(vim.ExtensibleManagedObject)
- Extended by
- Alarm, ClusterEVCManager, HostCpuSchedulerSystem, HostFirewallSystem, HostGraphicsManager, HostMemorySystem, HostNetworkSystem, HostPciPassthruSystem, HostServiceSystem, HostStorageSystem, HostVirtualNicManager, HostVMotionSystem, ManagedEntity, ScheduledTask, Task, VirtualMachineSnapshot
- See also
- CustomFieldDef, CustomFieldValue
- Since
- 2.0
Managed Object Description
ExtensibleManagedObject provides methods and properties that provide access to custom fields that may be associated with a managed object. Use the CustomFieldsManager to define custom fields. The CustomFieldsManager handles the entire list of custom fields on a server. You can can specify the object type to which a particular custom field applies by setting its managedObjectType. (If you do not set a managed object type for a custom field definition, the field applies to all managed objects.)Properties
| Name | Type | Description |
|---|---|---|
| availableField* P | CustomFieldDef[] |
List of custom field definitions that are valid for the object's type.
The fields are sorted by name.
Since VI API 2.5 |
| value* P | CustomFieldValue[] |
List of custom field values. Each value uses a key to associate
an instance of a CustomFieldStringValue with
a custom field definition.
Since VI API 2.5 |
Methods
| Methods defined in this Managed Object |
|---|
| setCustomValue |
setCustomValue
Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the fieldInstancePrivileges for the CustomFieldDef whose value is being changed.- Required Privileges
- None
- Since
- VI API 2.5
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ExtensibleManagedObject used to make the method call. |
| key | xsd:string |
The name of the field whose value is to be updated.
Since VI API 2.5 |
| value | xsd:string |
Value to be assigned to the custom field.
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 Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |