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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* vSphere API 4.0
dnsName P	xsd:string	*Since* vSphere API 4.0
vmSearch P	xsd: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
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* vSphere API 4.0
ip P	xsd:string	*Since* vSphere API 4.0
vmSearch P	xsd: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
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* vSphere API 4.0
uuid P	xsd:string	*Since* vSphere API 4.0
vmSearch P	xsd:boolean	*Since* vSphere API 4.0
instanceUuid* P	xsd: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
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

A reference to the SearchIndex used to make the method call.

datacenter P

ManagedObjectReference
to a Datacenter

Since null

path P

xsd:string

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VirtualMachine

Faults

Type	Description
InvalidDatastore
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* null
dnsName P	xsd:string	*Since* null
vmSearch P	xsd:boolean	*Since* null

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

Return Value

Type	Description
ManagedObjectReference to a ManagedEntity

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

A reference to the SearchIndex used to make the method call.

inventoryPath P

xsd:string

Since null

P Required privilege: inventoryPath

Return Value

Type	Description
ManagedObjectReference to a ManagedEntity

Faults

Type	Description
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* null
ip P	xsd:string	*Since* null
vmSearch P	xsd:boolean	*Since* null

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

Return Value

Type	Description
ManagedObjectReference to a ManagedEntity

Faults

Type	Description
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the SearchIndex used to make the method call.
datacenter* P	ManagedObjectReference to a Datacenter	*Since* null
uuid P	xsd:string	*Since* null
vmSearch P	xsd:boolean	*Since* null
instanceUuid* P	xsd:boolean	*Since* null

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

Return Value

Type	Description
ManagedObjectReference to a ManagedEntity

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

A reference to the SearchIndex used to make the method call.

entity P

ManagedObjectReference
to a ManagedEntity

Since null

name P

xsd:string

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ManagedEntity

Faults

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

Events

Type
None