Share via

Set-SCStoragePool

  • Reference
Module:
VirtualMachineManager

Modifies a storage pool object in the VMM database.

Syntax

Set-SCStoragePool
   [-StorageClassification <StorageClassification>]
   [-StoragePool] <StoragePool>
   [-Name <String>]
   [-Description <String>]
   [-AddVMHostGroup <HostGroup[]>]
   [-RemoveVMHostGroup <HostGroup[]>]
   [-AddStoragePhysicalDisk <StoragePhysicalDisk[]>]
   [-RemoveStoragePhysicalDisk <StoragePhysicalDisk[]>]
   [-Optimize]
   [-FaultDomainAwareness <FaultDomainAwarenessType>]
   [-InterleaveDefaultKB <UInt64>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

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.

Examples

Example 1: Change the name of a storage pool

PS C:\> $Pool = @(Get-SCStoragePool)[0]
PS C:\> Set-SCStoragePool -StoragePool $Pool -Name "New name of pool"

The first command gets all storage pool objects and 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".

Example 2: Set the classification for a storage 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

The first command gets the storage pool object with the ID of 346e17e9-d50a-480e-8dec-c41d7e2125b0 and stores the object in the $Pool variable.

The second command gets the storage classification object named StorageClassification01 and stores the object in the $Classification variable.

The last command associates the storage classification stored in $Classification (StorageClassification01) with the storage pool stored in $Pool.

Parameters

-AddStoragePhysicalDisk

Specifies an array of physical disk objects to add.

Type:StoragePhysicalDisk[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AddVMHostGroup

Specifies an array of host groups that this cmdlet adds to an existing host group array or private cloud.

Type:HostGroup[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

States a description for the specified object.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FaultDomainAwareness

Specifies the default fault domain for new virtual disks created in this storage pool. The acceptable values for this parameter are:

  • 1: PhysicalDisk
  • 2: StorageEnclosure
  • 3: Node
Type:FaultDomainAwarenessType
Accepted values:NotSupported, PhysicalDisk, StorageEnclosure, StorageScaleUnit
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterleaveDefaultKB

Specifies the default interleave size, in kilobytes, for new virtual disks created in this storage pool.

Type:UInt64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a VMM object.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Optimize

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveStoragePhysicalDisk

Specifies an array of physical disks to remove from this storage pool.

Type:StoragePhysicalDisk[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveVMHostGroup

Specifies an array of host groups that this cmdlet removes from a host group array or private cloud.

Type:HostGroup[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageClassification

Specifies a storage classification object.

Type:StorageClassification
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StoragePool

Specifies a storage pool object.

Type:StoragePool
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

StoragePool

This cmdlet returns a StoragePool object.