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

Add-VBRvCDCloudSubTenant

Short Description

Creates vCD cloud subtenant accounts.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRvCDCloudSubTenant -vCDTenant <VBRvCDCloudTenant> -vCDOrganizationUser <VBRvCloudOrganizationUser> -Resources <VBRCloudSubTenantResource[]> [-Description <String>] [-Disabled [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet creates new vCD cloud subtenant accounts.

Add-VBRvCDCloudSubTenant Note:

Before creating a vCD cloud subtenant account, you must perform the following:

  • Add the vCD cloud tenant into your Veeam Backup & Replication infrastructure
  • Create users in VMware vCloud Director. The vCD users must be granted the role, different from the administrator one.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

vCDTenant

Specifies the vCD cloud tenant account. Veeam Backup & Replication will check for the existing users on this tenant, to add them as the subtenant into the backup infrastructure.

Accepts the VBRvCDCloudTenant type.

True

Named

True, (ByValue, ByPropertyName)

False

vCDOrganizationUser

Specifies the vCD cloud user account that you want to add to the subtenant.

Accepts the VBRvCloudOrganizationUser type.

True

Named

True, (ByValue, ByPropertyName)

False

Resources

Specifies the quota of backup resources that you want to allocate to the vCD cloud sub tenant accounts.

Accepts the VBRCloudTenantResource type.

True

Named

False

False

Description

Specifies the description of the vCD cloud subtenant accounts.

False

Named

False

False

Disabled

Indicates that the subtenant is disabled.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example 1

This example shows how to add a vCD cloud subtenant account to your Veeam Backup & Replication infrastructure. The subtenant quota is set to 50 GB.

  1. Run Find-VBRvCloudEntity to get the necessary vCD user. Save the result to the $vcduser variable,
  2. Run Get-VBRCloudTenant to get the necessary vCD tenant. Save the result to the $vcdtenant variable.
  3. Get the parent resources. Use the Resources property of the VBRCloudTenantResource object saved to the $parent variable. Save the result to the $parent variable.
  4. Run New-VBRCloudSubTenantResource with the $parent variable. Use the RepositoryFriendlyName parameter to specify the repository name and the Quota parameter to specify the allowed storage imitations.
  5. Run Add-VBRvCDCloudSubTenant with the $vcduser, $vcdtenant and $subres variables.

$vcduser = Find-VBRvCloudEntity -OrganizationUser -Name vCDUser

$vcdtenant = Get-VBRCloudTenant -Name "vCDTenant"

$parent = $vcdtenant.Resources[0]

$subRes = New-VBRCloudSubTenantResource -Parent $parent -RepositoryFriendlyName "Cloudrepository" -Quota 50

Add-VBRvCDCloudSubTenant -vCDOrganizationUser $vcduser -vCDTenant $vcdtenant -Resources $subres -Description "NewCloudSubTenant"

Example 2

This example shows how to add a vCD cloud subtenant account to your Veeam Backup & Replication infrastructure. The subtenant quota is unlimited.

  1. Run Find-VBRvCloudEntity to get the necessary vCD user. Save the result to the $vcduser variable.
  2. Run Get-VBRCloudTenant to get the necessary vCD tenant. Save the result to the $vcdtenant variable.
  3. Run New-VBRCloudSubTenantResource with the $vcdtenant variable. Use the Resources property of the VBRCloudTenantResource saved to the $vcdtenant variable. Use the RepositoryFriendlyName parameter to specify the repository name and the Quota parameter to specify the allowed storage imitations.
  4. Run Add-VBRvCDCloudSubTenant with the $vcduser, $vcdtenant and $subres variables.

$vcduser = Find-VBRvCloudEntity -OrganizationUser -Name vCDUser

$vcdtenant = Get-VBRCloudTenant -Name vCDTenant

$subRes = New-VBRCloudSubTenantResource -Parent $vcdtenant.Resources[0] -RepositoryFriendlyName "Cloudrepository" -Unlimited

Add-VBRvCDCloudSubTenant -vCDOrganizationUser $vcduser -vCDTenant $vcdtenant  -Resources $subres -Description "NewCloudSubTenant"

Related Commands

Find-VBRvCloudEntity

Get-VBRCloudTenant

New-VBRCloudSubTenantResource

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation