Scripting Object - VcCustomFieldsManager

Scripting-object corresponding to
CustomFieldsManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting 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 {@link vim.ManagedEntity#customValue} property and through the summary objects for {@link vim.VirtualMachine} and {@link vim.HostSystem}. They are not available directly through this managed object.

This functionality is only available through VirtualCenter.

Attributes

Name Type Description
fieldVcCustomFieldDef []

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, addCustomFieldDef, createTrigger, getEntitiesWithCustomFieldAndValue, removeCustomFieldDef, renameCustomFieldDef, retrieveCustomFields, setField

retrieveCustomFields

Retrieve Custom fields based on specified custom field names. If there is no name specified, all custom fields will be returned. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcCustomFieldDef []

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

renameCustomFieldDef

Renames a custom field. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1String


Return Value

Type Description
None

getEntitiesWithCustomFieldAndValue

Returns all the list of ManagedEntities that the name is a Substring or Exact name of the custom field and the value is a Substring or Exact value of the field value. The name and value are case insensitive. For example "oba" matches with custom field name "fooBar" for the substring search case. For the exact match case "foobar" matches with custom field name "fooBar". @since vSphere API 6.5

Parameters

NameTypeDescription
arg0String

arg1String

arg2Boolean


Return Value

Type Description
VcManagedEntity []

removeCustomFieldDef

Removes a custom field. This also removes all values assigned to this custom field. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
None

setField

Assigns a value to a custom field on an entity. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1Number

arg2String


Return Value

Type Description
None

addCustomFieldDef

Creates a new custom field. If the moType is specified, the field will only be available for that type of managed object. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String

arg2VcPrivilegePolicyDef

arg3VcPrivilegePolicyDef


Return Value

Type Description
VcCustomFieldDef