Find-VBRvCloudEntity

Short Description

Looks for Cloud Director entities.

Platform: VMware

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

Syntax

This cmdlet provides the following parameter sets:

Full (Default)

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

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

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

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

Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-EntityRef <String>] [-Vm] [<CommonParameters>]
OrganizationVdc

Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-EntityRef <String>] [-OrganizationVdc] [<CommonParameters>]
StorageProfile

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

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

Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-EntityRef <String>] [-Vc] [<CommonParameters>]
Organization

Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-EntityRef <String>] [-Organization] [<CommonParameters>]
OrganizationUser

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

Detailed Description

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

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

Run the Get-VBRvCDCloudOrganizationvDC cmdlet to get the organization VDC.
Run the Get-VBRvCDCloudStoragePolicy cmdlet to get the Cloud Director storage policy.
Run the Get-VBRvCDCloudvApp cmdlet to get Cloud Director vApps.
Run the Get-VBRvCDCloudOrganizationUser cmdlet to get the organization users.

Important

Consider the following:

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Datastore	Defines that the cmdlet will return only datastores.	`SwitchParameter`	False	Named	False
EntityRef	Specifies one of the following Cloud Director entities: `VM` `vApp` `OrganizationVDC` `Organization` The cmdlet will return these entities.	`String`	False	Named	False
Full	Defines that the cmdlet will return only Cloud Director entities.	`SwitchParameter`	False	Named	False
Name	Specifies the array of Cloud Director entity names. The cmdlet will return entities with these names.	`String[]`	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
OrganizationVdc	Defines that the cmdlet will return only organization VDCs.	`SwitchParameter`	False	Named	False
Server	Specifies the array of servers. The cmdlet will return Cloud Director entities located on these servers. Accepts the `CHost[]` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost[]`	False	Named	True (ByPropertyName, ByValue)
StorageProfile	Defines that the cmdlet will return only storage profiles.	`SwitchParameter`	False	Named	False
Template	Defines that the cmdlet will return only vApp templates.	`SwitchParameter`	False	Named	False
VApp	Defines that the cmdlet will return only vApps.	`SwitchParameter`	False	Named	False
Vc	Defines that the cmdlet will return only vCenter Servers managed by Cloud Director.	`SwitchParameter`	False	Named	False
Vm	Defines that the cmdlet will return only VMs.	`SwitchParameter`	False	Named	False
VmTemplate	Defines that the cmdlet will return only VM templates.	`SwitchParameter`	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-VBRvCloudEntity Example 1. Getting All Cloud Entities

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

$server = Get-VBRServer -Name "172.16.1.13"

Find-VBRvCloudEntity -Server $server -Full

Perform the following steps:

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

Find-VBRvCloudEntity Example 2. Getting Cloud Director Server by Name

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

$server = Get-VBRServer -Name "172.16.1.13"

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

Perform the following steps:

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

Find-VBRvCloudEntity Example 3. Getting vApps on Specific Cloud Director Server

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

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

Find-VBRvCloudEntity -Server $server -VApp

Perform the following steps:

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

Find-VBRvCloudEntity Example 4. Getting Datastore on Sprecific Cloud Director Server

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

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

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

Perform the following steps:

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

Find-VBRvCloudEntity Example 5. Getting All Organization DCs

This command gets all Organization DCs.

Find-VBRvCloudEntity -OrganizationVdc

Get-VBRServer