Set-VBRCloudSubUserResource

Short Description

Modifies quotas of cloud subuser resources settings.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides 3 parameter sets.

  • To modify the repository friendly name:

Set-VBRCloudSubUserResource -CloudSubUserResource <VBRCloudSubUserResource> [-RepositoryFriendlyName <string>] [<CommonParameters>]

  • To modify the disk space limits:

Set-VBRCloudSubUserResource -CloudSubUserResource <VBRCloudSubUserResource> [-RepositoryFriendlyName <string>] [-Quota <int>]  [<CommonParameters>]

  • To change the disk space quota to unlimited:

Set-VBRCloudSubUserResource -CloudSubUserResource <VBRCloudSubUserResource> [-RepositoryFriendlyName <string>] [-Unlimited]  [<CommonParameters>]

Detailed Description

This cmdlet modifies the VBRCloudSubUserResource object. This object contains the quota of the cloud user backup resources. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

Run Set-VBRCloudSubUser to apply the changes.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CloudSubUserResource

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

Accepts VBRCloudSubUserResource type.

True

Named

True (ByValue,
ByProperty
Name)

False

RepositoryFriendlyName

Specifies the name you want to give to the subuser quota.

This name will be displayed in the list of backup repositories at the subuser side.

False

Named

False

False

Quota

Specifies the amount of space you want to give to the subuser on the selected backup repository.

Permitted value: 1 to 2097151  (GB).

False

Named

False

False

Unlimited

Indicates that the quota of resources has unlimited disk space.

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

VBRCloudSubUserResource

Example 1

This example shows how to modify the repository friendly name for a cloud subuser.

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

$subuser = Get-VBRCloudSubUser -Name "Alpha"

$subuserresources = $subuser.Resources[0]

Set-VBRCloudSubUserResource -CloudSubUserResource $subuserresources -RepositoryFriendlyName "Alpha Cloud Repository"

Example 2

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

  1. Run Get-VBRCloudSubUser to get the subuser. Save the result to the $subuser variable.
  2. Get the existing subuser quota using the Resources property of the VBRCloudSubUserResource object saved to the $subuser variable. Save the result to the $subuserresources variable.
  3. Run Set-VBRCloudSubUserResource. Use the $subuserresources variable.

$subuser = Get-VBRCloudSubUser -Name "Alpha"

$subuserresources = $subuser.Resources[0]

Set-VBRCloudSubUserResource -CloudSubUserResource $subuserresources -Quota 30

Example 3

This example shows how to set unlimited disk space to a cloud subuser.

  1. Run Get-VBRCloudSubUser to get the subuser. Save the result to the $subuser variable.
  2. Get the existing subuser quota using the Resources property of the VBRCloudSubUserResource object saved to the $subuser variable. Save the result to the $subuserresources variable.
  3. Run Set-VBRCloudSubUserResource. Use the $subuserresources variable.

$subuser = Get-VBRCloudSubUser -Name "Alpha"

$subuserresources = $subuser.Resources[0]

Set-VBRCloudSubUserResource -CloudSubUserResource $subuserresources -Unlimited

Related Commands

Get-VBRCloudSubUser