Managed Object - ExtensibleManagedObject

Extended by
Alarm, HostCpuSchedulerSystem, HostFirewallSystem, HostMemorySystem, HostNetworkSystem, HostPciPassthruSystem, HostServiceSystem, HostStorageSystem, HostVirtualNicManager, HostVMotionSystem, ManagedEntity, ScheduledTask, Task, VirtualMachineSnapshot
See also
CustomFieldDef, CustomFieldValue


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*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*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
*May not be present

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
Dynamic - See discussion above
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ExtensibleManagedObject used to make the method call.
keyxsd:string

The name of the field whose value is to be updated.
valuexsd:string

Value to be assigned to the custom field.

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if no custom field with that key exists.
RuntimeFaultThrown 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