| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
The custom fields values set on managed entities are available through the CustomValue property and through the summary objects for VirtualMachine and HostSystem. They are not available directly through this managed object.
This functionality is only available through VirtualCenter.
Properties
Name | Type | Description |
---|---|---|
field* P | CustomFieldDef[] |
List of custom fields defined on this server. The fields are
sorted by name.
|
Methods
Methods defined in this Managed Object |
---|
AddCustomFieldDef, RemoveCustomFieldDef, RenameCustomFieldDef, SetField |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CustomFieldsManager used to make the method call. |
name P | xsd:string |
The name of the field.
Since 2.0 |
moType* P | xsd:string |
The managed object type to which this field
will apply
Since 2.0 |
fieldDefPolicy* P | PrivilegePolicyDef |
Privilege policy to apply to FieldDef being
created
Since 2.0 |
fieldPolicy* P | PrivilegePolicyDef |
Privilege policy to apply to instances of field
Since 2.0 |
Return Value
Type | Description |
---|---|
CustomFieldDef |
Faults
Type | Description |
---|---|
DuplicateName | Thrown if a custom field with the name already exists. |
InvalidPrivilege | Thrown if a specified privilege is not defined. |
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 CustomFieldsManager used to make the method call. |
key P | xsd:int |
The unique key for the field definition.
Since 2.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the CustomFieldsManager used to make the method call. |
key P | xsd:int |
The unique key for the field definition.
Since 2.0 |
name P | xsd:string |
The new name for the field.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DuplicateName | Thrown if a custom field with the name already exists. |
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 CustomFieldsManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
Since 2.0 |
key P | xsd:int |
Since 2.0 |
value P | xsd:string |
Since 2.0 |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |