This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRvCDCloudSubUser

Short Description

Creates vCD cloud subuser accounts.

Applies to

Platform: VMware

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

Syntax

Add-VBRvCDCloudSubUser -CloudProvider <VBRCloudProvider> -vCDCloudOrganizationUser <VBRvCDCloudOrganizationUser> -Resources <VBRCloudSubUserResource[]> [-Description <string>] [-Disabled]  [<CommonParameters>]

Detailed Description

This cmdlet creates vCD cloud subuser accounts from the tenant side. You can use these accounts to back up Windows and Linux computers that are protected by Veeam Agent. The backups of these machines will be stored on the cloud repository.

Add-VBRvCDCloudSubUser Note:

Mind the following:

  • This cmdlet is available for tenants only.
  • Run Add-VBRvCDCloudSubTenant to create the vCD cloud subtenant on the provider side.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CloudProvider

Specifies a cloud service provider. The resources of this cloud service provider will be a parent for the subuser.

Accepts the VBRCloudProvider type.

True

Named

True (ByValue,
ByPropertyName)

 

VBRvCDCloudOrganizationUser

Specifies vCD cloud user accounts that you want to add.

Accepts the VBRvCDCloudOrganizationUser type.

True

Named

True (ByValue,
ByPropertyName)

 

Resources

Specifies the quota of the subtenant backup resources that you want to give to the subtenant.

Accepts the VBRCloudTenantResource type.

True

Named

False

 

Description

Specifies a description of a vCD cloud subuser account.

False

Named

False

 

Disabled

Indicates that a vCD cloud subuser is disabled.

False

Named

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

This example shows how to create a vCD cloud subuser account on the tenant side.

  1. Run Get-VBRCloudProvider to get the cloud service provider. Save the result to the $provider variable.
  2. Run Get-VBRvCDCloudOrganizationUser to get the cloud user account. Save the result to the $user variable.
  3. Run Get-VBRBackupRepository to get the repository. Save the result to the $rep variable.
  4. Run New-VBRCloudSubUserResource with the $rep variable. Save the result to the $resources variable.
  5. Run Add-VBRvCDCloudSubUser with the $provider, $user and $resources variables

$provider = Get-VBRCloudProvider -Name "vCDProvider"

$user = Get-VBRvCDCloudOrganizationUser -Name "vCDCloudUser"

$rep = Get-VBRBackupRepository -Name "vCD Repository"

$resources = New-VBRCloudSubUserResource -CloudRepository $rep -RepositoryFriendlyName "StrawberryJam" -Quota 50

Add-VBRvCDCloudSubUser -CloudProvider $provider -vCDCloudOrganizationUser $user -Resources  $resources

Related Commands

Get-VBRCloudProvider

Get-VBRvCDCloudOrganizationUser

Get-VBRBackupRepository

New-VBRCloudSubUserResource