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:

Consider the following:

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

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

CloudProvider

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

Accepts the VBRCloudProvider object. To get this object, run the Get-VBRCloudProvider cmdlet.

True

Named

True (ByValue,
ByPropertyName)

VBRvCDCloudOrganizationUser

Specifies vCD cloud user accounts that you want to add.

Accepts the VBRvCDCloudOrganizationUser object. To get this object, run the Get-VBRvCDCloudOrganizationUser cmdlet.

True

Named

True (ByValue,
ByPropertyName)

Resources

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

Accepts the VBRCloudSubUserResource[] object. To create this object, run the New-VBRCloudSubUserResource cmdlet.

True

Named

False

Description

Specifies a description of a vCD cloud subuser account.

String

False

Named

False

Disabled

Defines that a vCD cloud subuser is disabled.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

VBRvCDCloudSubUser

Examples

Creating vCD Cloud Subuser Account on Tenant Side

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

$provider = Get-VBRCloudProvider -Name "vCDProvider"

$user = Get-VBRvCDCloudOrganizationUser -Name "vCDCloudUser"

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

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

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

Perform the following steps:

  1. Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter value. Save the result to the $provider variable.
  2. Run the Get-VBRvCDCloudOrganizationUser cmdlet. Specify the Name parameter value. Save the result to the $user variable.
  3. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $rep variable.
  4. Run the New-VBRCloudSubUserResource cmdlet. Set the $rep variable as the CloudRepository parameter value. Specify the RepositoryFriendlyName and the Quota parameter values. Save the result to the $resources variable.
  5. Run the Add-VBRvCDCloudSubUser cmdlet. Set the $provider variable as the CloudProvider parameter value. Set the $user variable as the vCDCloudOrganizationUser parameter value. Set the $resources variable as the Resources parameter value.

Related Commands