This is an archive version of the document. To get the most up-to-date information, see the current version.

Find-VBRObject (obsolete)

Short Description

Returns a list of all VMs and VM containers on the specified ESXi host.

Note

This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using Find-VBRViEntity and Find-VBRHvEntity cmdlets.

Applies to

Platform: VMware

Syntax

Find-VBRObject [-Server] <CHost> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns a list of all VMs and VM containers on the specified ESXi host.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Server

Specifies the host you want to look for objects on.

True

1

True (ByValue,
ByProperty
Name)

False

Name

Specifies the name of the object you want to get, or search conditions.

You can specify multiple names separated by commas.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This command looks all objects registered on server named named "VMwareHost". The server object is obtained with Get-VBRServer and piped down.

Get-VBRServer -Name "VMwareHost" | Find-VBRObject

Example 2

This command looks for VMs named "VM01" and "VM03" located on server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand.

Find-VBRObject -Server $server -Name "VM01", "VM03"

Related Commands

Get-VBRServer