Set-SCCloudCapacity

Set-SCCloudCapacity

Modifies the cloud capacity settings for a private cloud.

Syntax

Parameter Set: FromValues
Set-SCCloudCapacity -CloudCapacity <CloudCapacity> [-CPUCount <UInt32> ] [-CustomQuotaCount <UInt32> ] [-JobVariable <String> ] [-MemoryMB <UInt32> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-StorageGB <UInt32> ] [-UseCPUCountMaximum <Boolean> ] [-UseCustomQuotaCountMaximum <Boolean> ] [-UseMemoryMBMaximum <Boolean> ] [-UseStorageGBMaximum <Boolean> ] [-UseVMCountMaximum <Boolean> ] [-VMCount <UInt32> ] [-VMMServer <ServerConnection> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: JobGroupParamSet
Set-SCCloudCapacity -JobGroup <Guid]> [-CPUCount <UInt32> ] [-CustomQuotaCount <UInt32> ] [-JobVariable <String> ] [-MemoryMB <UInt32> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-StorageGB <UInt32> ] [-UseCPUCountMaximum <Boolean> ] [-UseCustomQuotaCountMaximum <Boolean> ] [-UseMemoryMBMaximum <Boolean> ] [-UseStorageGBMaximum <Boolean> ] [-UseVMCountMaximum <Boolean> ] [-VMCount <UInt32> ] [-VMMServer <ServerConnection> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SCCloudCapacity cmdlet modifies the cloud capacity settings for a private cloud in Virtual Machine Manager (VMM). You can update the following cloud capacity dimensions:

-- virtual machines
-- virtual CPUs
-- custom quota points
-- storage (GB)
-- memory (MB)

Alternatively, you can set any or all of the dimensions to use the maximum capacity.

Parameters

-CloudCapacity<CloudCapacity>

Specifies a cloud capacity object.

-CPUCount<UInt32>

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<UInt32>

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<UInt32>

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

-PROTipID<Guid]>

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

-RunAsynchronously

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

-StorageGB<UInt32>

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<Boolean>

Indicates whether the maximum number of virtual CPUs is allowed for a user role or cloud capacity. When you specify a value of $True, no quota is enforced for the virtual CPU dimension.

-UseCustomQuotaCountMaximum<Boolean>

Indicates whether the maximum number of custom quota points is allowed for a user role or cloud capacity. When you specify a value of $True, no quota is enforced for the custom quota dimension.

-UseMemoryMBMaximum<Boolean>

Indicates whether the maximum amount of memory, in megabytes (MB), is allowed for a user role or cloud capacity. When you specify a value of $True, no quota is enforced for the memory dimension.

-UseStorageGBMaximum<Boolean>

Indicates whether the maximum amount of storage, in gigabytes (GB), is allowed for a user role or cloud capacity. When you specify a value of $True, no quota is enforced for the storage dimension.

-UseVMCountMaximum<Boolean>

Indicates whether the maximum number of virtual machines is allowed for a user role or cloud capacity. When you specify a value of $True, no quota is enforced for the virtual machine dimension.

-VMCount<UInt32>

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

-VMMServer<ServerConnection>

Specifies a VMM server object.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<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.

Examples

Example 1: Change the cloud capacity properties of a specified cloud

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

The second command gets the cloud capacity for the private cloud stored in $Cloud, and then stores it in the $CloudCapacity variable.

The last command indicates that there should be a limit placed on the virtual CPU count for the cloud capacity stored in $CloudCapacity, and changes the virtual CPU count capacity to 20.

PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> $CloudCapacity = Get-SCCloudCapacity -Cloud $Cloud
PS C:\> Set-SCCloudCapacity -CloudCapacity $CloudCapacity -VirtualCPUCountLimited $True -VirtualCPUCount 20

Example 2: Change the cloud capacity properties of a specific private cloud using a job group

The first command creates a new GUID, and then stores it in the $Guid variable. Subsequent commands that include this GUID are collected into a single job group.

The second command gets the private cloud object named Cloud02, and then stores the object in the $Cloud variable.

The third command gets the cloud capacity object for the private cloud stored in $Cloud, and stores the object in the $CloudCapacity variable.

The fourth command sets a limit of 50 virtual machines, 100 virtual CPUs and 500 GB of storage on the cloud capacity. Using the JobGroup parameter specifies that this command will not run until just before the final command that includes the JobGroup with the same GUID.

The last command sets the capacity properties on the private cloud stored in $Cloud using the settings that were specified in the fourth command. This command uses the JobGroup parameter to run Set-SCCloudCapacity just before Set-SCCloud runs so that the settings will be associated with the specified private cloud.

PS C:\> $Guid = [System.Guid]::NewGuid()
PS C:\> $Cloud = Get-SCCloud -Name "Cloud02"
PS C:\> $CloudCapacity = Get-SCCloudCapacity -Cloud $Cloud
PS C:\> Set-SCCloudCapacity -JobGroup $Guid -VirtualMachinesLimited $True -VirtualMachines 50 -VirtualCPUCountLimited $True -VirtualCPUCount 100 -StorageLimited $True -StorageGB 500
PS C:\> Set-SCCloud -JobGroup $Guid -Cloud $Cloud

Related topics

Get-SCCloud

Get-SCCloudCapacity

Set-SCCloud