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

Remove-VBRCloudTenant

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 <IVBRTenant[]> [-WhatIf] [-Confirm]  [<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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Cloud
Tenant

Specifies the array of tenant accounts you want to remove.

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

<CommonParameters>

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 remove all cloud tenant accounts registered in Veeam Backup & Replication.

  1. Run Get-VBRCloudTenant to get the cloud tenant accounts. Save the result to the $cloudtenants variable.
  2. Run Remove-VBRCloudTenant with the $cloudtenants variable.

$cloudtenants = Get-VBRCloudTenant

Remove-VBRCloudTenant -CloudTenant $cloudtenants

Example 2

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

  1. Run Get-VBRCloudTenant to get the cloud tenant account that you want to remove. Save the result to the $vCDtenant variable.
  2. Run Remove-VBRCloudTenant with the $vCDtenant variable.

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

Remove-VBRCloudTenant -CloudTenant $vCDtenant

Example 3

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

  1. Run Get-VBRBackupRepository to get the necessary repository. Save the result to the $repository variable.
  2. Run Get-VBRCloudTenant with the $repository variable to get the cloud tenant accounts. Save the result to the $tenant variable.
  3. Run Remove-VBRCloudTenant with the $tenant variable.

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

$tenant = Get-VBRCloudTenant -Repository $repository

Remove-VBRCloudTenant -CloudTenant $tenant

Related Commands

Get-VBRCloudTenant

Get-VBRBackupRepository

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation