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

Reset-VBRCloudTenant

Short Description

Resets licenses for cloud account tenants.

Applies to

Platform: VMware, Hyper-V

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

Requires a cloud provider license.

Syntax

Reset-VBRCloudTenant -CloudTenant <IVBRTenant[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet resets cloud account tenant license. You can reset the license for the cloud tenant accounts of the following types:

Simple cloud tenant accounts
vCD Cloud tenant accounts

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
CloudTenant	Specifies the array of tenant accounts for which you want to reset the tenant license. Accepts the VBRCloudTenant type.	True	Named	True (ByValue, ByProperty Name)	False
WhatIf	Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	False	Named	False	False
Confirm	Specifies whether the cmdlet displays a prompt that asks if the tenant is sure that they want to continue.	False	Named	False	False

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CloudTenant

Specifies the array of tenant accounts for which you want to reset the tenant license.

Accepts the VBRCloudTenant type.

True

Named

True (ByValue,
ByProperty
Name)

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the tenant is sure that they want to continue.

False

Named

False

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

Return Type

None.

Example 1

This example shows how to reset a license for the simple cloud tenant.

Run Get-VBRCloudTenant to get the simple cloud tenant account that you want to reset. Save the result to the $simpletenant variable.
Run Reset-VBRCloudTenant with the $simpletenant variable.

$simpletenant Get-VBRCloudTenant -Name "ABC Company"

Reset-VBRCloudTenant -CloudTenant $simpletenant

Example 2

This example shows how to reset a license for the vCD cloud tenant account.

Run Get-VBRCloudTenant to get the vCD tenant account that you want to reset. Save the result to the $CloudUsers variable.
Run Reset-VBRCloudTenant with the $CloudUsers variable.

$simpletenants Get-VBRCloudTenant -Name "CloudUser*"

Reset-VBRCloudTenant -CloudTenant $CloudUsers

Related Commands

Get-VBRCloudTenant