Scripting Object - VcSearchIndex

Scripting-object corresponding to
SearchIndex
Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

The SearchIndex service allows a client to efficiently query the inventory for a specific managed entity by attributes such as UUID, IP address, DNS name, or datastore path. Such searches typically return a VirtualMachine or a HostSystem. While searching, only objects for which the user has sufficient privileges are considered. The findByInventoryPath and findChild operations only search on entities for which the user has view privileges; all other SearchIndex find operations only search virtual machines and hosts for which the user has read privileges. If the user does not have sufficient privileges for an object that matches the search criteria, that object is not returned.

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, createTrigger, findAllByDnsName, findAllByIp, findAllByUuid, findByDatastorePath, findByDnsName, findByInventoryPath, findByIp, findByUuid, findChild

findAllByUuid

@since Unknown

Parameters

NameTypeDescription
datacenterVcDatacenter

uuidString

vmSearchBoolean

instanceUuidBoolean


Return Value

Type Description
VcManagedEntity []

_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

findByInventoryPath

Finds a managed entity based on its location in the inventory. The path is separated by slashes ('/'). For example, a path should be of the form "My Folder/My Datacenter/vm/Discovered VM/VM1". A leading slash or trailing slash is ignored. Thus, the following paths all represents the same object: "a/b", "/a/b", "a/b/", and '/a/b/'. Slashes in names must be represented using %2f, following the standard URL syntax. Any object in the inventory can be retrieved using this method, including resource pools and hosts. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcManagedEntity

findChild

Finds a particular child based on a managed entity name. This only searches the immediate children of a managed entity. For a {@link vim.Datacenter Datacenter}, the host and vm folders are considered children. For a {@link vim.ComputeResource ComputeResource}, the hosts and root {@link vim.ResourcePool ResourcePool} are considered children. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1String


Return Value

Type Description
VcManagedEntity

findByDnsName

Finds a virtual machine or host by DNS name. The DNS name for a virtual machine is the one returned from VMware tools, {@link vim.vm.GuestInfo#hostName}. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String

arg2Boolean


Return Value

Type Description
VcManagedEntity

findAllByIp

@since Unknown

Parameters

NameTypeDescription
datacenterVcDatacenter

ipString

vmSearchBoolean


Return Value

Type Description
VcManagedEntity []

findAllByDnsName

@since Unknown

Parameters

NameTypeDescription
datacenterVcDatacenter

dnsNameString

vmSearchBoolean


Return Value

Type Description
VcManagedEntity []

findByIp

Finds a virtual machine or host by IP address, where the IP address is in dot-decimal notation. For example, 10.17.12.12. The IP address for a virtual machine is the one returned from VMware tools, {@link vim.vm.GuestInfo#ipAddress}. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String

arg2Boolean


Return Value

Type Description
VcManagedEntity

findByUuid

Finds a virtual machine or host by BIOS or instance UUID. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String

arg2Boolean

arg3Boolean


Return Value

Type Description
VcManagedEntity

findByDatastorePath

Finds a virtual machine by its location on a datastore. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String


Return Value

Type Description
VcVirtualMachine