Set-SCStorageArray

Modifies the properties of a storage array object.

Syntax

Set-SCStorageArray
   [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod>]
   [-CreateStorageGroupsPerCluster <Boolean>]
   [-MaximumStorageLogicalUnitNameLength <Int16>]
   [-DiscoverPhysicalDisks]
   [-IOPSNormalizationSizeKB <UInt32>]
   [-StorageArray] <StorageArray>
   [-Name <String>]
   [-Description <String>]
   [-RemoveStoragePoolFromManagement <StoragePool[]>]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCStorageArray
   [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod>]
   [-CreateStorageGroupsPerCluster <Boolean>]
   [-MaximumStorageLogicalUnitNameLength <Int16>]
   [-DiscoverPhysicalDisks]
   [-IOPSNormalizationSizeKB <UInt32>]
   [-StorageArray] <StorageArray>
   [-Name <String>]
   [-Description <String>]
   -AddStoragePoolToManagement <StoragePool[]>
   -StorageClassificationAssociation <StorageClassification[]>
   [-VMHostGroupAssociation <HostGroup[]>]
   [-RemoveStoragePoolFromManagement <StoragePool[]>]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCStorageArray
   [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod>]
   [-CreateStorageGroupsPerCluster <Boolean>]
   [-MaximumStorageLogicalUnitNameLength <Int16>]
   [-DiscoverPhysicalDisks]
   [-IOPSNormalizationSizeKB <UInt32>]
   [-StorageArray] <StorageArray>
   [-Name <String>]
   [-Description <String>]
   [-RemoveStoragePoolFromManagement <StoragePool[]>]
   [-JobGroup <Guid>]
   -PeerStorageArrayName <String>
   [-Pair]
   [-UnPair]
   [-RunAsAccount <RunAsAccount>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCStorageArray cmdlet modifies the properties of a Virtual Machine Manager (VMM) storage array object.

Examples

Example 1: Change the name of a storage array

PS C:\> $Array = @(Get-SCStorageArray)[0]
PS C:\> Set-SCStorageArray -StorageArray $Array -Name "New Name"

The first command gets the first item in the storage array, and then stores it in the $Array variable.

The second command changes the name of the storage array stored in $Array to New Name.

Parameters

-AddStoragePoolToManagement

Indicates whether management of a storage pool through VMM is enabled. When set to $True, VMM imports all logical unit objects hosted by the storage pool.

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

-CreateStorageGroupsPerCluster

Indicates whether a storage group is created for each cluster.

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

-Description

Specifies a description for the storage array.

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

-DiscoverPhysicalDisks

Indicates that the cmdlet performs a level 3 discovery of physical disks.

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

-IOPSNormalizationSizeKB

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

-JobGroup

Specifies an ID for a series of commands that run as a set just before the final command that includes the same job group ID runs.

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

-JobVariable

Specifies the name of a variable in which to track and store job progress.

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

-LogicalUnitCopyMethod

Specifies the method used by the array to copy an existing logical unit. Valid values are: Clone and Snapshot.

Type:StorageLogicalUnitCopyMethod
Accepted values:Snapshot, Clone, RemoteMirror
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumStorageLogicalUnitNameLength

Specifies the maximum length that the name for a logical unit can be.

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

-Name

Specifies the name for the storage array.

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

-Pair

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

-PeerStorageArrayName

Type:String
Position:Named
Default value:None
Required:True
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

-RemoveStoragePoolFromManagement

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.

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

-RunAsAccount

Type:RunAsAccount
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

-StorageArray

Specifies a storage array object. This array can be a Fibre Channel or iSCSI storage sub-system that is used to store virtual machine configuration and virtual disks.

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

-StorageClassificationAssociation

Specifies an array of storage classification objects that is associated with a storage pool.

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

-UnPair

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

-VMHostGroupAssociation

Specifies an array of host group objects.

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

Outputs

StorageArray

This cmdlet returns a StorageArray object.