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

Disable-VBRCloudTenant

Short Description

Disables cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

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

Detailed Description

This cmdlet disables a cloud tenant account. When you disable a tenant account, the tenant cannot use their account resources. You can disable the cloud tenant accounts of the following types:

  • Simple cloud tenant accounts
  • vCD Cloud tenant accounts

Run Enable-VBRCloudTenant to enable a disabled account.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Cloud
Tenant

Specifies the array of cloud tenant accounts you want to disable.

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 user is sure that they want to continue.

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

None

Example 1

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

  1. Run Get-VBRCloudTenant with the Name parameter to get the necessary vCD cloud tenant. Save the result to the $tenant variable.
  2. Run Disable-VBRCloudTenant with the CloudTenant parameter. Use the $tenant variable to specify the vCD cloud tenant.

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

Disable-VBRCloudTenant -CloudTenant $tenant

Example 2

This example shows how to disable several cloud tenant accounts.

  1. Run Get-VBRCloudTenant with the Name parameter to get the necessary tenant. Save the result to the $tenant variable.
  2. Run Disable-VBRCloudTenant with the CloudTenant parameter. Use the $tenant variable to specify the cloud tenant.

$tenant = Get-VBRCloudTenant -Name "ABC Company Tenant", "vCD Tenant"

Disable-VBRCloudTenant -CloudTenant $tenant

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 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

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation