| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
FindAllByDnsName, FindAllByIp, FindAllByUuid, FindByDatastorePath, FindByDnsName, FindByInventoryPath, FindByIp, FindByUuid, FindChild |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
dnsName | xsd:string |
The fully qualified domain name to find.
|
vmSearch | xsd:boolean |
If true, search for virtual machines, otherwise search for
hosts.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | The list of all virtual machines or hosts that are found. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
ip | xsd:string |
The dot-decimal notation formatted IP address to find.
|
vmSearch | xsd:boolean |
If true, search for virtual machines, otherwise search for
hosts.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | The list of all virtual machines or hosts that are found. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
uuid | xsd:string |
The UUID to find. If vmSearch is true, the UUID can be either BIOS
or instance UUID.
|
vmSearch | xsd:boolean |
If true, search for virtual machines, otherwise search for
hosts.
|
instanceUuid* | xsd:boolean |
Should only be set when vmSearch is true. If specified, search
for virtual machines whose instance UUID matches the given uuid.
Otherwise, search for virtual machines whose BIOS UUID matches the given
uuid.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ManagedEntity[] | The list of all virtual machines or hosts that are matching with the given UUID. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter | ManagedObjectReference
to a Datacenter |
Specifies the datacenter to which the datastore path belongs.
|
path | xsd:string |
A datastore path to the .vmx file for the virtual machine.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a VirtualMachine | The virtual machine that is found. If no virtual machine is found, null is returned. Only a single entity is returned, even if there are multiple matches. |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if a datastore has not been specified in the path or if the specified datastore does not exist on the specified datacenter. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
dnsName | xsd:string |
The fully qualified domain name to find.
|
vmSearch | xsd:boolean |
if true, search for virtual machines, otherwise search for
hosts.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ManagedEntity | The virtual machine or host managed entity that is found. If no managed entities are found, null is returned. Only a single entity is returned, even if there are multiple matches. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
inventoryPath | xsd:string |
The path to the entity.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ManagedEntity | The managed entity that is found. If no match is found, null is returned. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
ip | xsd:string |
The dot-decimal notation formatted IP address to find.
|
vmSearch | xsd:boolean |
if true, search for virtual machines, otherwise search for
hosts.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ManagedEntity | The virtual machine or host managed entity that is found. If no managed entities are found, null is returned. Only a single entity is returned, even if there are multiple matches. If called directly on an ESX server with vmSearch set to false, returns the host managed entity if the address matches any of the Console OS IP addresses. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
datacenter* | ManagedObjectReference
to a Datacenter |
If specified, restricts the query to entities in
a particular datacenter. If not specified, the entire inventory is
searched.
|
uuid | xsd:string |
The UUID to find. If vmSearch is true, the uuid can be either BIOS
or instance UUID.
|
vmSearch | xsd:boolean |
If true, search for virtual machines, otherwise search for
hosts.
|
instanceUuid* | xsd:boolean |
Should only be set when vmSearch is true. If specified, search
for virtual machines whose instance UUID matches the given uuid.
Otherwise, search for virtual machines whose BIOS UUID matches the given
uuid.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ManagedEntity | The virtual machine or host managed entity that is found. If no managed entities are found, null is returned. Only a single entity is returned, even if there are multiple matches. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SearchIndex used to make the method call. |
entity | ManagedObjectReference
to a ManagedEntity |
A reference to a managed entity.
|
name | xsd:string |
The name of the child object.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ManagedEntity | The managed entity that is found, or null if no match is found. |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |