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

Add-VBRCloudSubUser

Short Description

Creates cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRCloudSubUser -CloudProvider <VBRCloudProvider> -Name <string> -Password <string> -Resources <VBRCloudSubUserResource[]> [-Description <string>] [-Disabled] [<CommonParameters>]

Detailed Description

This cmdlet creates new cloud subuser accounts.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
CloudProvider	Specifies the cloud provider. The resources of this provider will be parent for the subuser. Accepts VBRCloudProvider type.	True	Named	True (ByValue, ByProperty Name)	False
Name	Specifies the name you want to assign to the subuser account. The subuser name must meet the following requirements: The maximum length of the subuser name is 128 characters. It is recommended that you create short subuser names to avoid problems with long paths to backup files on the cloud repository. The subuser name may contain space characters. The subuser name must not contain the following characters: \/:*?\"<>\|=; as well as Unicode characters. The subuser name must not end with the period character [.].	True	Named	False	False
Password	Specifies the password you want to set to the subuser account.	True	Named	False	False
Resources	Specifies the quota of the subuser backup resources you want to give to the subuser. Accepts VBRCloudSubUserResource type.	True	Named	False	False
Description	Specifies the description of the cloud subuser account.	False	Named	False	False
Disabled	Indicates if the cloud subuser is disabled.	False	Named	False	False

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

Return Type

VBRCloudSubUser

Example

This example shows how to create a cloud subuser account.

[Preconfigure] Create the quota of the subuser resources. See New-VBRCloudSubUserResource for details. Save the result to the $subuserquota variable.
Run Get-VBRCloudProvider to get the parent cloud provider. Save the result to the $provider variable.
Run Add-VBRCloudSubUser. Use the $subuserquota and the $provider variables.

$cloudprovider = Get-VBRCloudProvider

Add-VBRCloudSubUser -CloudProvider $cloudprovider -Name "Subuser 1" -Password "Pass 123" -Resources $subuserquota

Related Commands

Get-VBRCloudProvider

Get-VBRBackupRepository

New-VBRCloudSubUserResource