vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - CustomFieldsManager(vim.CustomFieldsManager)
- Property of
- ServiceContent
- See also
- CustomFieldDef, ManagedEntity, PrivilegePolicyDef
- Since
- 2.0
Managed Object Description
The CustomFieldsManager object is used to add and remove custom fields to managed entities.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 |
AddCustomFieldDef(addFieldDefinition)
Creates a new custom field. If the moType is specified, the field will only be available for that type of managed object.- Required Privileges
- Global.ManageCustomFields
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the CustomFieldsManager used to make the method call. |
| name | xsd:string |
The name of the field.
Since 2.0 |
| moType* | xsd:string |
The managed object type to which this field
will apply
Since 2.0 |
| fieldDefPolicy* | PrivilegePolicyDef |
Privilege policy to apply to FieldDef being
created
Since 2.0 |
| fieldPolicy* | 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 | |
Show WSDL type definition
RemoveCustomFieldDef(removeFieldDefinition)
Removes a custom field. This also removes all values assigned to this custom field.- Required Privileges
- Global.ManageCustomFields
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the CustomFieldsManager used to make the method call. |
| key | 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 | |
Show WSDL type definition
RenameCustomFieldDef(renameFieldDefinition)
Renames a custom field.- Required Privileges
- Global.ManageCustomFields
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the CustomFieldsManager used to make the method call. |
| key | xsd:int |
The unique key for the field definition.
Since 2.0 |
| name | 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 | |
Show WSDL type definition
SetField(setField)
Assigns a value to a custom field on an entity.- Required Privileges
- 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 | xsd:int |
Since 2.0 |
| value | 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 | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |