Set-SCStorageArray
Set-SCStorageArray
Modifies the properties of a storage array object.
Syntax
Parameter Set: Default
Set-SCStorageArray [-StorageArray] <StorageArray> [-CreateStorageGroupsPerCluster <Boolean> ] [-Description <String> ] [-JobVariable <String> ] [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod> {Snapshot | Clone} ] [-MaximumStorageLogicalUnitNameLength <Int16> ] [-Name <String> ] [-PROTipID <Guid> ] [-RemoveStoragePoolFromManagement <StoragePool[]> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: EnablePoolManagement
Set-SCStorageArray [-StorageArray] <StorageArray> -AddStoragePoolToManagement <StoragePool[]> -StorageClassificationAssociation <StorageClassification[]> [-CreateStorageGroupsPerCluster <Boolean> ] [-Description <String> ] [-JobVariable <String> ] [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod> {Snapshot | Clone} ] [-MaximumStorageLogicalUnitNameLength <Int16> ] [-Name <String> ] [-PROTipID <Guid> ] [-RemoveStoragePoolFromManagement <StoragePool[]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Set-SCStorageArray cmdlet modifies the properties of a Virtual Machine Manager (VMM) storage array object.
Parameters
-AddStoragePoolToManagement<StoragePool[]>
Enables management of a storage pool through VMM. When set to $True, VMM imports all logical unit objects hosted by the storage pool.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CreateStorageGroupsPerCluster<Boolean>
Indicates whether a storage group is created for each cluster.
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 |
-LogicalUnitCopyMethod<StorageLogicalUnitCopyMethod>
Specifies the method used by the array to copy an existing logical unit. Valid values: Clone, Snapshot.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MaximumStorageLogicalUnitNameLength<Int16>
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 |
-RemoveStoragePoolFromManagement<StoragePool[]>
Removes a storage pool from VMM management. This parameter deletes all logical unit information from VMM, but does not delete any data from the logical units themselves.
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 |
-StorageArray<StorageArray>
Specifies a storage array object, This can be a Fibre Channel or iSCSI storage sub-system that is used to store virtual machine configuration and virtual disks.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-StorageClassificationAssociation<StorageClassification[]>
Specifies an array of storage classification objects that is associated with a storage pool.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
- StorageArray
Examples
1: Change the name of a storage array
The first command gets the first item in the storage array and stores it in the $Array variable.
The second command changes the name of the storage array stored in the $Array variable to "New Name".
PS C:\> $Array = @(Get-SCStorageArray)[0]
PS C:\> Set-SCStorageArray -StorageArray $Array -Name "New Name"