15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
2.2 KiB
vim.ExtensibleManagedObject
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.)
Attributes
- value (vim.CustomFieldsManager.Value):
- privilege: System.View
List of custom field values. Each value uses a key to associate an instance of a CustomFieldStringValue with a custom field definition.
- availableField (vim.CustomFieldsManager.FieldDef):
- privilege: System.View
List of custom field definitions that are valid for the object's type. The fields are sorted by name .
Methods
- setCustomValue(key, value):
-
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. since: VI API 2.5
- Privilege:
-
dynamic
- Args:
- Returns:
-
None
Raises:
- vmodl.fault.InvalidArgument:
-
if no custom field with that key exists.