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 the 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	Type	Required	Position	Accept Pipeline Input
Server	Specifies the host you want to look for objects on.	Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.	True	1	True (ByValue, ByProperty Name)
Name	Specifies the name of the object you want to get, or search conditions. You can specify multiple names separated by commas.	String[]	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Server

Specifies the host you want to look for objects on.

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

True

True (ByValue,
ByProperty
Name)

Name

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

You can specify multiple names separated by commas.

String[]

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Find-VBRObject (obsolete) Example 1. Getting All Objects on ServerBackup File to Specific Folder

This example shows how to look for all objects registered on the VMwareHost server.

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

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Find-VBRObject cmdlet.

Find-VBRObject (obsolete) Example 2. Getting All Objects on ServerBackup File to Specific Folder

This example shows how to look for all objects registered on the VMwareHost server.

$server = Get-VBRServer -Name "srv001"

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

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRObject cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value.

Related Commands

Get-VBRServer