Disable-VBRCloudTenant

Short Description

Disables cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

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

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 the Enable-VBRCloudTenant cmdlet to enable a disabled account.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

CloudTenant

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

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

True

Named

True (ByValue,
ByProperty
Name)

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

Disable-VBRCloudTenantExample 1. Disabling vCD Cloud Tenant Account

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

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

Disable-VBRCloudTenant -CloudTenant $tenant

Perform the following steps:

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

Disable-VBRCloudTenantExample 2. Disabling Several Cloud Tenant Accounts

This example shows how to disable several cloud tenant accounts.

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

Disable-VBRCloudTenant -CloudTenant $tenant

Perform the following steps:

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

Related Commands

Get-VBRCloudTenant