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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-CPUCount<UInt32>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CustomQuotaCount<UInt32>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MemoryMB<UInt32>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseCPUCountMaximum<Boolean>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseCustomQuotaCountMaximum<Boolean>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseMemoryMBMaximum<Boolean>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseStorageGBMaximum<Boolean>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseVMCountMaximum<Boolean>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMCount<UInt32>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<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

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

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

The second command gets the cloud capacity for the private cloud stored in $Cloud and 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

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

The first command creates a new GUID and 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 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 tha 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 assocated 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

Get-SCCloud

Get-SCCloudCapacity