Scripting Object - VcPropertyFilter

Attribute of
VcPropertyCollector, VcPropertyFilterUpdate
Returned by
createFilter

Scripting Object Description

The VcPropertyFilter managed object type defines a filter that controls the properties for which a VcPropertyCollector detects incremental changes. Filters are subordinate objects; they are part of the VcPropertyCollector and do not have independent lifetimes. A Filter is automatically destroyed when the session on which it was created is closed or the VcPropertyCollector on which it was created is destroyed.

Attributes

Name Type Description
idstring

returns the id of this ManagedObject
partialUpdatesboolean

Flag to indicate if a change to a nested property reports only the nested change or the entire specified property value. If the value is true, a change reports only the nested property. If the value is false, a change reports the enclosing property named in the filter.
referenceVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject
sdkConnectionVcSdkConnection

returns the parent SdkConnection
specVcPropertyFilterSpec

Specifications for this filter.
vimHostVcSdkConnection

returns the parent SdkConnection (deprecated)
vimTypestring

returns the type of this ManagedObject

Methods

Methods defined in this Scripting Object
createTrigger, destroyPropertyFilter

destroyPropertyFilter

Destroys this filter.

This operation can be called explicitly, or it can take place implicitly when the session that created the filter is closed.

Parameters

NameTypeDescription
None

Return Value

Type Description
None

createTrigger

Create a trigger from this ManagedObject

Parameters

NameTypeDescription
timeoutnumber

Waiting timout in seconds
filterstring

The monitored vCenter API filter
conditionstring

The condition in OGNL language
filterToSync*string

The vCenter API filter used to synchronize the content of the session
*Need not be set

Return Value

Type Description
Trigger