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 the following parameter sets:
- To look for all vCloud entities
Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-Full [<SwitchParameter>]] [<CommonParameters>] |
- To look for vApps
Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-VApp [<SwitchParameter>]] [<CommonParameters>] |
- To look for vApp templates
Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-Template [<SwitchParameter>]] [<CommonParameters>] |
- To look for VM templates
Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-VmTemplate [<SwitchParameter>]] [<CommonParameters>] |
- To look for VMs
Find-VBRvCloudEntity [-Name <string[]>] [-Server <CHost[]>] [-Vm] [<CommonParameters>] |
- To look for organization VDCs
Find-VBRvCloudEntity [-Name <string[]>] [-Server <CHost[]>] [-OrganizationVdc] [<CommonParameters>] |
- To look for storage profiles
Find-VBRvCloudEntity [-Name <string[]>] [-Server <CHost[]>] [-StorageProfile] [<CommonParameters>} |
- To look for datastores
Find-VBRvCloudEntity [-Name <String[]>] [-Server <CHost[]>] [-Datastore [<SwitchParameter>]] [<CommonParameters>] |
- To look for vCenter Servers managed by vCloud Director
Find-VBRvCloudEntity [-Name <string[]>] [-Server <CHost[]>] [-Vc] [<CommonParameters>} |
- To look for Organizations
Find-VBRvCloudEntity [-Name <string[]>] [-Server <CHost[]>] [-Organization] [<CommonParameters>] |
- To 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`s Veeam Backup & Replication, use the following cmdlets:
- Run Get-VBRvCDCloudOrganizationvDC to get the organization VDC
- Run Get-VBRvCDCloudStoragePolicy to get the vCD storage policy
- Run Get-VBRvCDCloudvApp to get vCD vApps
- Run Get-VBRvCDCloudOrganizationUser to get the organization users
|
Mind the following:
|
Parameters
Parameter | Description | Required | Position | Accept | Accept |
---|---|---|---|---|---|
Name | Specifies the array of vCloud entity names. The cmdlet will return entities with these names. | False | Named | False | True |
Server | Specifies the array of servers. The cmdlet will return vCloud entities located on these servers. | False | Named | True (ByValue, | False |
Full | Indicates that the cmdlet will return only vCloud entities. | False | Named | False | False |
VApp | Indicates that the cmdlet will return only vApps. | False | Named | False | False |
Template | Indicates that the cmdlet will return only vApp templates. | False | Named | False | False |
VmTemplate | Indicates that the cmdlet will return only VM templates. | False | Named | False | False |
Vm | Indicates that the cmdlet will return only VMs. | False | Named | False | False |
OrganizationVdc | Indicates that the cmdlet will return only organization VDCs. | False | Named | False | False |
StorageProfile | Indicates that the cmdlet will return only storage profiles. | False | Named | False | False |
Datastore | Indicates that the cmdlet will return only datastores. | False | Named | False | False |
Vc | Indicates that the cmdlet will return only vCenter Servers managed by vCloud Director. | False | Named | False | False |
Organization | Indicates that the cmdlet will return only Organizations. | False | Named | False | False |
OrganizationUser | Indicates that the cmdlet will return only Organization users. NOTE: The cmdlet will not return users with administrator roles. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Return Type
CVcdSystemItem
CVcdOrganizationItem
CVcdOrganizationVdcItem
CVcdVappItem
CVcdVmItem
CVcdOrgVdcStorageProfile
CVcdDatastoreRestoreInfo
CVcdVcInfo
VBRvCloudOrganizationUser
Example 1
This example shows how to look for all vCloud entities registered on the server.
- Run Get-VBRServer to get the necessary server.
- Run Find-VBRvCloudEntity with the $server variable.
$server = Get-VBRServer -Name "172.16.1.13" Find-VBRvCloudEntity -Server $server -Full |
Example 2
This example shows how to look for the particular vCloud Director server.
- Run Get-VBRServer to get the necessary server.
- Run Find-VBRvCloudEntity with the $server variable. Use the Name parameter to specify the entity that you want to get.
$server = Get-VBRServer -Name "172.16.1.13" Find-VBRvCloudEntity -Server $server -Name *SQL* |
Example 3
This example shows how to get the vApps on the particular vCloud Director server.
- Run Get-VBRServer to get the necessary server.
- Run Find-VBRvCloudEntity with the $server variable. Use the vApp parameter to get the array of the vApps.
$server = Get-VBRServer -Name "vCloud Server" Find-VBRvCloudEntity -Server $server -VApp |
Example 4
This example shows how to get the datastore on the particular vCloud Director server.
- Run Get-VBRServer to get the necessary server.
- Run Find-VBRvCloudEntity with the $server variable. Use the Datastore parameter to get the array of the datastores.
$server = Get-VBRServer -Name "vCloud Server" Find-VBRvCloudEntity -Server $server -Datastore -Name "Datastore 04" |
Example 5
This command gets all Organization DCs
Find-VBRvCloudEntity -OrganizationVdc |
Related Commands