Scripting Object - VcVirtualMachineMetadataManager

Scripting-object corresponding to
VirtualMachineMetadataManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

Metadata manager interface. This interface is used to manage metadata state about virtual machines stored on a datastore that supports VM metadata storage.

Attributes

Name Type Description
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, clearMetadata, createTrigger, retrieveAllMetadata, retrieveMetadata, updateMetadata

retrieveMetadata

Retrieves a populated VmMetadataResult[] for the given list of VMs. Each string in the vmId list should be a Datastore URL-based ID for a VM, for example, "[datastore1] SomeVM/SomeVM.vmx". @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVirtualMachineMetadataManagerVmMetadataOwner

arg1String []


Return Value

Type Description
VcVirtualMachineMetadataManagerVmMetadataResult []

_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

clearMetadata

Makes a best effort to clear all VmMetadata assigned to the specified owner for the given datastore. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVirtualMachineMetadataManagerVmMetadataOwner

arg1VcDatastore


Return Value

Type Description
VcVirtualMachineMetadataManagerVmMetadataResult []

retrieveAllMetadata

Retrieves an array of VmMetadataResults for all of the VMs on the named datastore. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVirtualMachineMetadataManagerVmMetadataOwner

arg1VcDatastore


Return Value

Type Description
VcVirtualMachineMetadataManagerVmMetadataResult []

updateMetadata

Operates on the given list of VmMetadata on behalf of the specified owner. If the operation is Update and the vmId already exists, its metadata will be replaced with the specified value. If the vmId doesn't already exist, the metadata entry will be created. If the operation is Remove, the metadata entry will be deleted if one exists for the specified vmId. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVirtualMachineMetadataManagerVmMetadataOwner

arg1VcVirtualMachineMetadataManagerVmMetadataInput []


Return Value

Type Description
VcVirtualMachineMetadataManagerVmMetadataResult []