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

Remove-VBRCloudTenant

In this article

Short Description

Removes cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Remove-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected cloud tenant account from Veeam Backup & Replication.

The tenant account is removed permanently. The service provider cannot undo this operation.

When you remove a cloud tenant account that was using WAN accelerators, the WAN accelerators' cache is cleared automatically.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Cloud Tenant	Specifies the array of tenant accounts you want to remove. Accepts VBRCloudTenant object.	True	Named	True (by Value FromPipeline, ValueFromPipeline ByPropertyName)	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

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

Related Commands

Get-VBRCloudTenant

Return Type

None

Example 1

This example shows how to remove all cloud tenant accounts registered in Veeam Backup & Replication.

Run Get-VBRCloudTenant to get the cloud tenant accounts and save them to $cloudtenants variable.
Run Remove-VBRCloudTenant using $cloudtenants variable.

PS C:\PS> $cloudtenants = Get-VBRCloudTenant

PS C:\PS> Remove-VBRCloudTenant -CloudTenant $cloudtenants

Example 2

This command removes the ABC company cloud tenant account.

The cloud tenant account is obtained by running Get-VBRCloudTenant and piped down.

PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Remove-VBRCloudTenant

Example 3

This command removes all cloud tenant accounts using the 'Backup Vol2' backup repository.

The backup repository is obtained by Get-VBRBackupRepository and piped down to Get-VBRCloudTenant. The obtained cloud tenant account are piped down to Remove-VBRCloudTenant.

PS C:\PS> Get-VBRBackupRepository -Name "Backups Vol2" | Get-VBRCloudTenant | Remove-VBRCloudTenant