Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Find-VBRvCloudEntity

Short Description

Looks for vCloud Director entities.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Find-VBRvCloudEntity [-Server <CHost[]>][-Full][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-VApp][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-Template][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-VmTemplate][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-OrganizationVdc][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-StorageProfile][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-Datastore][-Name <string[]>] [<CommonParameters>]

Find-VBRvCloudEntity [-Server <CHost[]>][-Vc][-Name <string[]>] [<CommonParameters>]

Detailed Description

This cmdlet looks for vCloud Director entities.

You can get the whole list of vCloud entities, or the list of specified entities (i.e. vApps), or narrow down the output by filtering by name.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Server

Specifies the array of servers. The cmdlet will return vCloud entities located on these servers.

False

Named

True (ByValue,
ByProperty
Name)

False

Full

Indicates that the cmdlet returns all vCloud entities.

False

Named

False

False

VApp

Indicates that the cmdlet returns vApps.

False

Named

False

False

Template

Indicates that the cmdlet returns vApp templates.

False

Named

False

False

VmTemplate

Indicates that the cmdlet returns VM templates.

False

Named

False

False

Organization
Vdc

Indicates that the cmdlet returns Organization vDCs.

False

Named

False

False

StorageProfile

Indicates that the cmdlet returns storage profiles.

False

Named

False

False

Datastore

Indicates that the cmdlet returns datastores.

False

Named

False

False

Vc

Indicates that the cmdlet returns vCenter Servers managed by vCloud Director.

False

Named

False

False

Name

Specifies the array of vCloud entity names. The cmdlet will return entities with these names.

False

Named

False

True

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

CVcdSystemItem

CVcdOrganizationItem

CVcdOrganizationVdcItem

CVcdVappItem

CVcdVmItem

CVcdOrgVdcStorageProfile

CVcdDatastoreRestoreInfo

CVcdVcInfo

Example 1

This command looks for all vCloud entities registered on the server represented by $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand.

PS C:\PS> Find-VBRvCloudEntity -Server $server -Full

Example 2

This command looks for the vCloud entities registered on the server with 172.16.1.13 IP address. The server object is obtained with Get-VBRServer and piped down. The output is filtered by name containing "SQL".

PS C:\PS> Get-VBRServer -Name "172.16.1.13" | Find-VBRvCloudEntity -Name *SQL*

Example 3

This command looks for the vApps registered on the server named "vCloud Server". The server object is obtained with Get-VBRServer and piped down.

PS C:\PS> Get-VBRServer -Name "vCloud Server" | Find-VBRvCloudEntity -VApp

Example 4

This command looks for the datastore named "Datastore 04" registered on the server represented by $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand.

PS C:\PS> Find-VBRvCloudEntity -Server $server -Datastore -Name "Datastore 04"

Related Commands

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation