Set-SCCloud
Set-SCCloud
Changes the properties of a private cloud in VMM.
Syntax
Parameter Set: Default
Set-SCCloud [[-Cloud] <Cloud> ] [-AddCapabilityProfile <List`1> ] [-AddCloudResource <List`1> ] [-AddReadOnlyLibraryShare <List`1> ] [-AddVMHostGroup <List`1> ] [-Description <String> ] [-DisasterRecoverySupported <Boolean]> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-ReadWriteLibraryPath <String> ] [-RemoveCapabilityProfile <List`1> ] [-RemoveCloudResource <List`1> ] [-RemoveReadOnlyLibraryShare <List`1> ] [-RemoveVMHostGroup <List`1> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Set-SCCloud cmdlet changes the properties of a private cloud in Virtual Machine Manager (VMM).
For more information about private clouds, type Get-Help New-SCCloud -detailed.
Parameters
-AddCapabilityProfile<List`1>
Adds one or more capability profile objects to a private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddCloudResource<List`1>
Adds one or more resources to a private cloud. Resources that you can add to a private cloud include: Load Balancer, Logical Network, Static IP Address Pool, Storage Pool, and VIP Template.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddReadOnlyLibraryShare<List`1>
Adds one or more specified read-only library shares to a private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddVMHostGroup<List`1>
Adds one or more host groups to an existing host group array or private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Cloud<Cloud>
Specifies a private cloud object.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DisasterRecoverySupported<Boolean]>
Indicates whether the Windows Azure Hyper-V Recovery Manager service is enabled.
If enabled, the cmdlet sends the following data over the internet to the service: cloud name, virtual machine names, logical network names, virtual machine host names, and the relevant properties for each object. If sending this information conflicts with existing privacy requirements for workloads that are deployed to this cloud, then do not select this option.
After pairing this cloud to a recovery cloud in Windows Azure Hyper-V Recovery Manager, you cannot disable this option.
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? |
false |
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 |
-Name<String>
Specifies the name of a VMM object.
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 |
-ReadWriteLibraryPath<String>
Specifies a writable library path to which virtual machines can be stored.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveCapabilityProfile<List`1>
Removes one or more specified capability profile objects.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveCloudResource<List`1>
Removes a specified resource from a private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveReadOnlyLibraryShare<List`1>
Removes a specified read-only library share.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveVMHostGroup<List`1>
Removes one or more host groups from a host group array or private cloud.
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 |
-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
Example 1: Update the properties of a 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 Cloud01, and then stores the object in the $Cloud variable.
The third command gets the Hyper-V capability profile object, and then stores the object in the $CapabilityProfile variable.
The fourth command sets the following limits on the cloud capacity dimensions: 500 GB storage, 50 virtual machines, and 100 CPUs. 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 adds the capability profile stored in $CapabilityProfile to Cloud01, updates the description for Cloud01, and sets the cloud capacity properties on Cloud01 using the settings 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 "Cloud01"
PS C:\> $CapabilityProfile = Get-SCCapabilityProfile -Profilename "HyperV"
PS C:\> Set-SCCloudCapacity -JobGroup $Guid -StorageLimited $True -StorageGB 500 -VirtualMachinesLimited $True -VirtualMachines 50 -VirtualCPUCountLimited $True -VirtualCPUCount 100
PS C:\> Set-SCCloud -Cloud $Cloud -AddCapabilityProfile $CapabilityProfile -JobGroup $Guid -Description "Updated description for Cloud01"