Set-SCUserRoleQuota

Set-SCUserRoleQuota

Modifies the settings for a user role quota.

Syntax

Parameter Set: JobGroup
Set-SCUserRoleQuota -Cloud <Cloud> -JobGroup <Guid]> [-CPUCount <Int32]> ] [-CustomQuotaCount <Int32]> ] [-JobVariable <String> ] [-MemoryMB <Int32]> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-QuotaPerUser] [-RunAsynchronously] [-StorageGB <Int32]> ] [-UseCPUCountMaximum] [-UseCustomQuotaCountMaximum] [-UseMaximumQuota] [-UseMemoryMBMaximum] [-UseStorageGBMaximum] [-UseVMCountMaximum] [-VMCount <Int32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: UseDefault
Set-SCUserRoleQuota -UseMaximumQuota [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-QuotaPerUser] [-RunAsynchronously] [-UserRoleQuota <UserRoleQuota> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: Values
Set-SCUserRoleQuota -UserRoleQuota <UserRoleQuota> [-CPUCount <Int32]> ] [-CustomQuotaCount <Int32]> ] [-JobVariable <String> ] [-MemoryMB <Int32]> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-StorageGB <Int32]> ] [-UseCPUCountMaximum] [-UseCustomQuotaCountMaximum] [-UseMemoryMBMaximum] [-UseStorageGBMaximum] [-UseVMCountMaximum] [-VMCount <Int32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCUserRoleQuota cmdlet modifies the settings for a Virtual Machine Manager (VMM) user role quota.

Parameters

-Cloud<Cloud>

Specifies a private cloud object.

-CPUCount<Int32]>

Specifies the number of CPUs on a virtual machine, on a hardware profile, or on a template. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.

-- Hyper-V. Up to four CPUs per virtual machine, depending on guest operating system.
-- VMware ESX. Up to four CPUs per virtual machine for any supported guest operating system, except for a virtual machine that runs Windows NT 4.0, which supports one CPU.
-- Citrix XenServer. Up to eight CPUs per virtual machine, depending on guest operating system.

-CustomQuotaCount<Int32]>

Specifies the number of custom quota points for a user role quota or cloud capacity.

-JobGroup<Guid]>

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-MemoryMB<Int32]>

Specifies the amount of memory in megabytes (MB) for a user role quota or cloud capacity.

-OnBehalfOfUser<System.String>

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-QuotaPerUser

Indicates whether the cmdlet sets or retrieves user level quotas or member level quotas. Specifying $True indicates member level quotas. Specifying $False indicates role level quotas. If the parameter is not used, both quotas are set or returned.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-StorageGB<Int32]>

Specifies the amount of storage in gigabytes (GB) for a user role quota or cloud capacity. This storage amount does not include library storage.

-UseCPUCountMaximum

Indicates that the maximum number of virtual CPUs is allowed for a user role or cloud capacity. When this parameter is used, no quota is enforced for the virtual CPU dimension.

-UseCustomQuotaCountMaximum

Indicates that the maximum number of custom quota points is allowed for a user role or cloud capacity. When this parameter is used, no quota is enforced for the custom quota dimension.

-UseMaximumQuota

Indicates that all quota dimensions are set to maximum. When this parameter is used, no quotas are enforced.

-UseMemoryMBMaximum

Indicates that the maximum amount of memory, in megabytes (MB), is allowed for a user role or cloud capacity. When this parameter is used, no quota is enforced for the memory dimension.

-UserRoleQuota<UserRoleQuota>

Specifies a user role quota object.

-UseStorageGBMaximum

Indicates that the maximum amount of storage, in gigabytes (GB), is allowed for a user role or cloud capacity. When this parameter is used, no quota is enforced for the storage dimension.

-UseVMCountMaximum

Indicates that the maximum number of virtual machines is allowed for a user role or cloud capacity. When this parameter is used, no quota is enforced for the virtual machine dimension.

-VMCount<Int32]>

Specifies the number of virtual machines for a user role quota or cloud capacity.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• UserRoleQuota

Examples

Example 1: Increase virtual machine count quota of a user role for a cloud

The first command gets the cloud object named Cloud01, and then stores the object in the $Cloud variable.

The second command gets the user role object named ContosoSelfServiceUsers, and then stores the object in the $Role variable.

The third command gets the user role quota for the cloud stored in $Cloud and user role stored in $Role. The QuotaPerUser parameter has a value of $False, and, therefore, the quota for the user role will be returned.

The last command determines whether the virtual machine quota is less than 20. If it is, then the command sets the quota to 20.

PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> $Role = Get-SCUserRole -Name "ContosoSelfServiceUsers"
PS C:\> $Quota = Get-SCUserRoleQuota -Cloud $Cloud -UserRole $Role -QuotaPerUser $False
PS C:\> Write-Output $Quota.VMCount
PS C:\> if ($Quota.VMCount -lt 20) {Set-SCUserRoleQuota -UserRoleQuota $quota -VMCount 20}

Related topics

Get-SCUserRoleQuota

Get-SCCloud

Get-SCUserRole