Share via


Set-SCStorageArray

Modifies the properties of a storage array object.

Syntax

Default (Default)

Set-SCStorageArray
    [-StorageArray] <StorageArray>
    [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod>]
    [-CreateStorageGroupsPerCluster <Boolean>]
    [-MaximumStorageLogicalUnitNameLength <Int16>]
    [-DiscoverPhysicalDisks]
    [-IOPSNormalizationSizeKB <UInt32>]
    [-Name <String>]
    [-Description <String>]
    [-RemoveStoragePoolFromManagement <StoragePool[]>]
    [-JobGroup <Guid>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

EnablePoolManagement

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

SetStoragePeerArray

Set-SCStorageArray
    [-StorageArray] <StorageArray>
    -PeerStorageArrayName <String>
    [-LogicalUnitCopyMethod <StorageLogicalUnitCopyMethod>]
    [-CreateStorageGroupsPerCluster <Boolean>]
    [-MaximumStorageLogicalUnitNameLength <Int16>]
    [-DiscoverPhysicalDisks]
    [-IOPSNormalizationSizeKB <UInt32>]
    [-Name <String>]
    [-Description <String>]
    [-RemoveStoragePoolFromManagement <StoragePool[]>]
    [-JobGroup <Guid>]
    [-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.

Parameter properties

Type:

StoragePool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnablePoolManagement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreateStorageGroupsPerCluster

Indicates whether a storage group is created for each cluster.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the storage array.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DiscoverPhysicalDisks

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IOPSNormalizationSizeKB

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogicalUnitCopyMethod

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

Parameter properties

Type:StorageLogicalUnitCopyMethod
Default value:None
Accepted values:Snapshot, Clone, RemoteMirror
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumStorageLogicalUnitNameLength

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

Parameter properties

Type:Int16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name for the storage array.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Pair

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetStoragePeerArray
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PeerStorageArrayName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetStoragePeerArray
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

StoragePool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsAccount

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

Parameter properties

Type:RunAsAccount
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetStoragePeerArray
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:StorageArray
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageClassificationAssociation

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

Parameter properties

Type:

StorageClassification[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnablePoolManagement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UnPair

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetStoragePeerArray
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMHostGroupAssociation

Specifies an array of host group objects.

Parameter properties

Type:

HostGroup[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnablePoolManagement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

StorageArray

This cmdlet returns a StorageArray object.