Managed Object - SearchIndex

Property of
ServiceContent
See also
Datacenter, ManagedEntity, VirtualMachine
Since
null


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
FindAllByDnsName, FindAllByIp, FindAllByUuid, FindByDatastorePath, FindByDnsName, FindByInventoryPath, FindByIp, FindByUuid, FindChild

FindAllByDnsName

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
dnsName Pxsd:string

Since vSphere API 4.0
vmSearch Pxsd:boolean

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindAllByIp

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
ip Pxsd:string

Since vSphere API 4.0
vmSearch Pxsd:boolean

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindAllByUuid

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since vSphere API 4.0
uuid Pxsd:string

Since vSphere API 4.0
vmSearch Pxsd:boolean

Since vSphere API 4.0
instanceUuid* Pxsd:boolean

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference[]
to a ManagedEntity[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindByDatastorePath

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter PManagedObjectReference
to a Datacenter

Since null
path Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a VirtualMachine

Faults

Type Description
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindByDnsName

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since null
dnsName Pxsd:string

Since null
vmSearch Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ManagedEntity

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindByInventoryPath

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
inventoryPath Pxsd:string

Since null
P Required privilege: inventoryPath

Return Value

Type Description
ManagedObjectReference
to a ManagedEntity

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindByIp

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since null
ip Pxsd:string

Since null
vmSearch Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ManagedEntity

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindByUuid

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
datacenter* PManagedObjectReference
to a Datacenter

Since null
uuid Pxsd:string

Since null
vmSearch Pxsd:boolean

Since null
instanceUuid* Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ManagedEntity

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



FindChild

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SearchIndex used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

Since null
name Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ManagedEntity

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None