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

Set-VBRCloudSubUser

Short Description

Modifies settings of cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRCloudSubUser -SubUser <VBRCloudSubUser> [-Description <string>] [-Password <string>] [-Disabled] [-Resources <VBRCloudSubUserResource[]>] [-PassThru] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a selected subuser account.

To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Set-VBRCloudSubUser Note:

You cannot modify the subuser name. After the subuser account is created, the name becomes a part of system information and cannot be changed.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

SubUser

Specifies the cloud subuser you want to modify.

Accepts VBRCloudSubUser type.

True

Named

True (by Value
FromPipeline)

False

Description

Specifies the description of the cloud subuser account.

False

Named

False

False

Password

Specifies the password you want to set to the subuser account.

False

Named

False

False

Disabled

Indicates if the cloud subuser is disabled.

False

Named

False

False

Resources

Specifies the quota of the subuser backup resources you want to give to the subuser.

Accepts VBRCloudSubUserResource type.

False

Named

False

False

PassThru

Indicates that the command returns the output object to the Windows PowerShell console.

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

VBRCloudSubUser

Example 1

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

  1. Run Get-VBRCloudSubUser to get the cloud subuser. Save the result to the $subuser variable.
  2. Run Set-VBRCloudSubUser. Use the $subuser variable.

PS C:\PS> $subuser = Get-VBRCloudSubUser -Name "Subuser 1"

PS C:\PS> Set-VBRCloudSubUser -SubUser $subuser -Password "Pass12345"

Example 2

This example shows how to disable a selected cloud subuser.

  1. Run Get-VBRCloudSubUser to get the cloud subuser.
  2. Run Set-VBRCloudSubUser. Use the $subuser variable.

PS C:\PS> $subuser = Get-VBRCloudSubUser -Name "Subuser 1"

PS C:\PS> Set-VBRCloudSubUser -SubUser $subuser -Disabled

Example 3

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

  1. Run Get-VBRCloudSubUser to get the cloud subuser. Save the result to the $subuser variable.
  2. Get the existing quota of the subuser. Use the Resources property of the VBRCloudSubUserResource object saved to the $subuser variable. Save the result to the $subuserresources variable.
  3. Modify the cloud subuser quota. Run Set-VBRCloudSubUserResource with the $subuserresources variable. Save the result to the $newresources.
  4. Run Set-VBRCloudSubUser with the $subuser and the $subuserresources variables.

PS C:\PS> $subuser = Get-VBRCloudSubUser -Name "Subuser 1"

PS C:\PS> $subuserresources = $subuser.Resources[0]

PS C:\PS> $newresources = Set-VBRCloudSubUserResource -CloudSubUserResource $subuserresources -Quota 20

PS C:\PS> Set-VBRCloudSubUser -SubUser $subuser -Resources $newresources

Related Commands

Get-VBRCloudSubUser

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation