Set-SCStoragePool
Set-SCStoragePool
Modifies a storage pool object in the VMM database.
Syntax
Parameter Set: Default
Set-SCStoragePool [-StoragePool] <StoragePool> [-AddStoragePhysicalDisk <StoragePhysicalDisk[]> ] [-AddVMHostGroup <HostGroup[]> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RemoveVMHostGroup <HostGroup[]> ] [-RunAsynchronously] [-StorageClassification <StorageClassification> ] [ <CommonParameters>]
Detailed Description
The Set-SCStoragePool cmdlet modifies a storage pool object in the Virtual Machine Manager (VMM) database. You can change the properties of a storage pool, add a VMHostGroup to the storage pool, or remove a VMHostGroup from a storage pool.
Parameters
-AddStoragePhysicalDisk<StoragePhysicalDisk[]>
Specifies a physical disk object or objects to add.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddVMHostGroup<HostGroup[]>
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 |
-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 |
-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 |
-RemoveVMHostGroup<HostGroup[]>
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 |
-StorageClassification<StorageClassification>
Specifies a storage classification object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StoragePool<StoragePool>
Specifies a storage pool object.
Aliases |
none |
Required? |
true |
Position? |
1 |
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.
- StoragePool
Examples
Example 1: Change the name of a storage pool
The first command gets all storage pool objects, and then places them in an array. The command then stores the first item in the storage pool array in the $Pool variable.
The second command changes the name of the storage pool stored in the $Pool variable to New name of pool.
PS C:\> $Pool = @(Get-SCStoragePool)[0]
PS C:\> Set-SCStoragePool -StoragePool $Pool -Name "New name of pool"
Example 2: Set the classification for a storage pool
The first command gets the storage pool object with the ID of 346e17e9-d50a-480e-8dec-c41d7e2125b0, and then stores the object in the $Pool variable.
The second command gets the storage classification object named StorageClassification01, and then stores the object in the $Classification variable.
The last command associates the storage classification stored in $Classification with the storage pool stored in $Pool.
PS C:\> $Pool = Get-SCStoragePool -ID "346e17e9-d50a-480e-8dec-c41d7e2125b0"
PS C:\> $Classification = Get-SCStorageClassification -Name "StorageClassification01"
PS C:\> Set-SCStoragePool -StoragePool $Pool -StorageClassification $Classification