---
title: "Set-VBRCloudSubTenant"
description: "This cmdlet modifies settings for the cloud subtenant accounts of the following types: Simple cloud tenant accounts Cloud Director tenant accounts To modify settings, specify new values for the necessary parameters."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrcloudsubtenant.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Cloud Connect > Veeam Cloud Connect Subtenants > Set-VBRCloudSubTenant"
dateModified: "2026-08-19"
---

# Set-VBRCloudSubTenant

## Short Description
Modifies settings of cloud subtenant accounts.

**Platform**: VMware, Hyper-V

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

## Syntax
```
Set-VBRCloudSubTenant -SubTenant <IVBRCloudSubTenant> [-Description <String>] [-Password <String>]
 [-HashedPassword] [-Disabled] [-Resources <VBRCloudSubTenantResource[]>] [-PassThru] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings for the cloud subtenant accounts of the following types:

- Simple cloud tenant accounts
- Cloud Director tenant accounts

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

You cannot modify the following settings:

- The cloud subuser name. After the subuser account is created, the name becomes a part of system information and cannot be changed.
- For Agent Management subusers: user name and resources.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the cloud subtenant account.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Disabled</span></p>
        </td>
        <td>
          <p>Defines if the cloud subtenant is disabled.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">HashedPassword</span></p>
        </td>
        <td>
          <p>Defines that you submit the hashed password. The hashed passwords are stored in the Veeam backup database.</p><p>Use this parameter, for example, to restore subtenant accounts.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PassThru</span></p>
        </td>
        <td>
          <p>Defines that the command returns the output object to the Windows PowerShell console.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Password</span></p>
        </td>
        <td>
          <p>Specifies the password you want to set to the subtenant account.</p><p><strong>Note</strong>: This parameter is available for the Cloud Director tenant accounts.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Resources</span></p>
        </td>
        <td>
          <p>Specifies the quota of the subtenant backup resources you want to give to the subtenant.</p><p>Accepts the <a href="vbrcloudsubtenantresource.md"><code>VBRCloudSubTenantResource[]</code></a> object. To get this object, run the <a href="set-vbrcloudsubtenantresource.md"><code>Set-VBRCloudSubTenantResource</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrcloudsubtenantresource.md"><code>VBRCloudSubTenantResource[]</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SubTenant</span></p>
        </td>
        <td>
          <p>Specifies the cloud subtenant you want to modify.</p><p>Accepts the <code>IVBRCloudSubTenant</code> object. To get this object, run the <a href="get-vbrcloudsubtenant.md"><code>Get-VBRCloudSubtenant</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IVBRCloudSubTenant</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
[`VBRCloudSubTenant`](vbrcloudsubtenant.md)

## Examples

::: example
### Example 1. Changing Password for Selected Cloud Subtenant

This example shows how to modify the password for a selected cloud subtenant.

```
$subtenant = Get-VBRCloudSubTenant -Name "Alpha"
Set-VBRCloudSubTenant -SubTenant $subtenant -Password "Pass12345"
```

Perform the following steps:

1. Run the [`Get-VBRCloudSubtenant`](get-vbrcloudsubtenant.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$subtenant` variable.
2. Run the `Set-VBRCloudSubTenant` cmdlet. Set the `$subtenant` variable as the `SubTenant` parameter value. Specify the `Password` parameter value.

:::

::: example
### Example 2. Disabling Selected Cloud Subtenant

This example shows how to disable a selected cloud subtenant.

```
$subtenant = Get-VBRCloudSubTenant -Name "Alpha"
Set-VBRCloudSubTenant -SubTenant $subtenant -Disabled
```

Perform the following steps:

1. Run the [`Get-VBRCloudSubtenant`](get-vbrcloudsubtenant.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$subtenant` variable.
2. Run the `Set-VBRCloudSubTenant` cmdlet. Set the `$subtenant` variable as the `SubTenant` parameter value. Provide the `Disabled` parameter.

:::

::: example
### Example 3. Modifying Resource Quota for Selected Cloud Subtenant

This example shows how to modify the quota of resources for a selected cloud subtenant.

```
$subtenant = Get-VBRCloudSubTenant -Name "Alpha"
$subtenantresources = $subtenant.Resources[0]
$newresources = Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresources -Quota 20
Set-VBRCloudSubTenant -SubTenant $subtenant -Resources $newresources
```

Perform the following steps:

1. Run the [`Get-VBRCloudSubtenant`](get-vbrcloudsubtenant.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$subtenant` variable.
2. Get the existing quota of the subtenant. Use the `Resources` property of the [`VBRCloudSubTenantResource`](vbrcloudsubtenantresource.md) object saved to the `$subtenant` variable. Save the result to the `$subtenantresources` variable.
3. Run the [`Set-VBRCloudSubTenantResource`](set-vbrcloudsubtenantresource.md) cmdlet. Set the `$subtenantresources` variable as the `CloudSubTenantResource` parameter value. Specify the `Quota` parameter value. Save the result to the `$newresources` variable.
4. Run the `Set-VBRCloudSubTenant` cmdlet to apply changes. Set the `$subtenant` variable as the `SubTenant` parameter value. Set the `$newresources` variable as the `Resources` parameter value.

:::

## Related Commands

- [`Get-VBRCloudSubTenant`](get-vbrcloudsubtenant.md)
- [`Set-VBRCloudSubTenantResource`](set-vbrcloudsubtenantresource.md)