Find-VBRvCloudEntity

Short Description

Looks for vCloud Director entities.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Look for all vCloud entities.

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

  • Look for vApps.

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

  • Look for vApp templates.

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

  • Look for VM templates.

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

  • Look for VMs.

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

  • Look for organization VDCs.

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

  • Look for storage profiles.

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

  • Look for datastores.

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

  • Look for vCenter Servers managed by vCloud Director.

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

  • Look for Organizations.

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

  • Look for Organization users.

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

Detailed Description

This cmdlet looks for vCloud Director entities. Use this cmdlet to get vCloud Director entities from the Service Provider's Veeam backup server.

To get vCloud Director entities from the Tenant Veeam Backup & Replication, use the following cmdlets:

Find-VBRvCloudEntity Important!

Consider the following:

  • This cmdlet works from the Service Provider side only.
  • The cmdlet will not return users with administrator roles.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

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

String[]

False

Named

False

Server

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

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

False

Named

True (ByValue,
ByProperty
Name)

Full

Defines that the cmdlet will return only vCloud entities.

SwitchParameter

False

Named

False

VApp

Defines that the cmdlet will return only vApps.

SwitchParameter

False

Named

False

Template

Defines that the cmdlet will return only vApp templates.

SwitchParameter

False

Named

False

VmTemplate

Defines that the cmdlet will return only VM templates.

SwitchParameter

False

Named

False

Vm

Defines that the cmdlet will return only VMs.

SwitchParameter

False

Named

False

OrganizationVdc

Defines that the cmdlet will return only organization VDCs.

SwitchParameter

False

Named

False

StorageProfile

Defines that the cmdlet will return only storage profiles.

SwitchParameter

False

Named

False

Datastore

Defines that the cmdlet will return only datastores.

SwitchParameter

False

Named

False

Vc

Defines that the cmdlet will return only vCenter Servers managed by vCloud Director.

SwitchParameter

False

Named

False

Organization

Defines that the cmdlet will return only Organizations.

SwitchParameter

False

Named

False

OrganizationUser

Defines that the cmdlet will return only Organization users.

Note: The cmdlet will not return users with administrator roles.

SwitchParameter

False

Named

False

EntityRef

Specifies one of the following vCloud Director entities:

  • VM
  • vApp
  • OrganizationVDC
  • Organization

The cmdlet will return these entities.

String

False

Named

False

<CommonParameters>

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

Output Object

  • CVcdSystemItem
  • CVcdOrganizationItem
  • CVcdOrganizationVdcItem
  • CVcdVappItem
  • CVcdVmItem
  • CVcdOrgVdcStorageProfile
  • CVcdDatastoreRestoreInfo
  • CVcdVcInfo
  • VBRvCloudOrganizationUser

Examples

Find-VBRvCloudEntityExample 1. Getting All vCloud Entities

This example shows how to look for all vCloud entities registered on the server.

$server = Get-VBRServer -Name "172.16.1.13"

Find-VBRvCloudEntity -Server $server -Full

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value.
  2. Run the Find-VBRvCloudEntity cmdlet. Set the $server variable as the Server parameter value. Provide the Full parameter.

Find-VBRvCloudEntityExample 2. Getting vCloud Director Server by Name

This example shows how to look for the particular vCloud Director server.

$server = Get-VBRServer -Name "172.16.1.13"

Find-VBRvCloudEntity -Server $server -Name *SQL*

Perform the following steps:

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

Find-VBRvCloudEntityExample 3. Getting vApps on Specific vCloud Director Server

This example shows how to get the vApps on the particular vCloud Director server.

$server = Get-VBRServer -Name "vCloud Server"

Find-VBRvCloudEntity -Server $server -VApp

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Find-VBRvCloudEntity cmdlet. Set the $server variable as the Server parameter value. Provide the VApp parameter.

Find-VBRvCloudEntityExample 4. Getting Datastore on Sprecific vCloud Director Server

This example shows how to get the datastore on the particular vCloud Director server.

$server = Get-VBRServer -Name "vCloud Server"

Find-VBRvCloudEntity -Server $server -Datastore -Name "Datastore 04"

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Find-VBRvCloudEntity cmdlet. Set the $server variable as the Server parameter value. Provide the Datastore parameter. Specify the Name parameter value.

Find-VBRvCloudEntityExample 5. Getting All Organization DCs

This command gets all Organization DCs.

Find-VBRvCloudEntity -OrganizationVdc

Related Commands

Get-VBRServer