Remove-VBRCloudTenant

Short Description

Removes cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

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

Requires a cloud provider license.

Syntax

Remove-VBRCloudTenant -CloudTenant <IVBRCloudTenant[]> [-IncludeBackups [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet removes cloud tenant accounts. You can remove the accounts of the following types:

  • Simple cloud tenant accounts
  • vCD Cloud tenant accounts

The tenant account is removed permanently from Veeam Backup & Replication. 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

Type

Required

Position

Accept
Pipeline
Input

CloudTenant

Specifies the array of tenant accounts you want to remove.

Accepts the VBRCloudTenant[] object. To get this object, run the Get-VBRCloudTenant cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

IncludeBackups

Defines that the cmdlet will remove all tenant backups.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Remove-VBRCloudTenantExample 1. Removing All Cloud Tenant Accounts

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

$cloudtenants = Get-VBRCloudTenant

Remove-VBRCloudTenant -CloudTenant $cloudtenants

Perform the following steps:

  1. Run the Get-VBRCloudTenant cmdlet. Save the result to the $cloudtenants variable.
  2. Run the Remove-VBRCloudTenant cmdlet. Set the $cloudtenants variable as the CloudTenant parameter value.

Remove-VBRCloudTenantExample 2. Removing vCD Cloud Tenant Account

This example shows how to remove a vCD cloud tenant account.

$vCDtenant = Get-VBRCloudTenant -Name "vCD Tenant"

Remove-VBRCloudTenant -CloudTenant $vCDtenant

Perform the following steps:

  1. Run the Get-VBRCloudTenant cmdlet.  Specify the Name parameter value. Save the result to the $vCDtenant variable.
  2. Run the Remove-VBRCloudTenant cmdlet. Set the $vCDtenant variable as the CloudTenant parameter value.

Remove-VBRCloudTenantExample 3. Removing All Cloud Tenant Accounts by Repository

This example shows how to remove all cloud tenant accounts by specifying their backup repository.

$repository = Get-VBRBackupRepository -Name "Backups Vol2"

$tenant = Get-VBRCloudTenant -Repository $repository

Remove-VBRCloudTenant -CloudTenant $tenant

Perform the following steps:

  1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Get-VBRCloudTenant cmdlet. Set the $repository variable as the Repository parameter value. Save the result to the $tenant variable.
  3. Run the Remove-VBRCloudTenant cmdlet. Set the $tenant variable as the CloudTenant parameter value.

Related Commands