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

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 a new cloud subuser account.

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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRCloudSubUser

Example

This example shows how to create a cloud subuser account.

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

PS C:\PS> $cloudprovider = Get-VBRCloudProvider

PS C:\PS> Add-VBRCloudSubUser -CloudProvider $cloudprovider -Name "Subuser 1" -Password "Pass 123" -Resources $subuserquota

Related Commands

Get-VBRCloudProvider

Get-VBRBackupRepository

New-VBRCloudSubUserResource

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation