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

Add-VBRCloudSubTenant

Short Description

Creates cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRCloudSubTenant -Tenant <VBRCloudTenant> -Name <string> -Password <string> -Resources <VBRCloudSubTenantResource[]> [-Description <string>] [-HashedPassword] [-Disabled] [<CommonParameters>]

Detailed Description

This cmdlet creates a new cloud subtenant account.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Tenant

Specifies the parent tenant. The cmdlet will use resources of this tenant as parent resources for the subtenant.

Accepts VBRCloudTenant type.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Name

Specifies the name you want to assign to the subtenant account.

The subtenant name must meet the following requirements:

  • The maximum length of the subtenant name is 128 characters. It is recommended that you create short subtenant names to avoid problems with long paths to backup files on the cloud repository.
  • The subtenant name may contain space characters.
  • The subtenant name must not contain the following characters: \/:*?\"<>|=; as well as Unicode characters.
  • The subtenant name must not end with the period character [.].

True

Named

False

False

Password

Specifies the password you want to set to the subtenant account.

True

Named

False

False

Recources

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

Accepts VBRCloudSubTenantResource type.

True

Named

False

False

Description

Specifies the description of the cloud subtenant account.

False

Named

False

False

HashedPassword

Indicates that you submit the hashed password. The hashed passwords are stored in Veeam backup database.

Use this parameter, for example, to restore subtenant accounts.

False

Named

False

False

Disabled

Indicates that the cloud subtenant 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

VBRCloudSubTenant

Example

This example shows how to create a cloud subtenant account.

  1. [Preconfigure] Create the quota of the subtenant resources. See New-VBRCloudSubTenantResource for details. Save the result to the $subtenantquota variable.
  2. Run Get-VBRCloudTenant to get the parent cloud tenant. Save the result to the $tenant variable.
  3. Run Add-VBRCloudSubTenant. Use the saved variables.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "Alpha"

PS C:\PS> Add-VBRCloudSubTenant -Tenant $tenant -Name "Alpha" -Password "Pass123" -Resources $subtenantquota

Related Commands

Get-VBRCloudTenant

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 Endpoint Backup Documentation

Veeam Management Pack Documentation