Edit

Set-StorageSubSystem

  • Reference
Module:
Storage

Modifies the properties of a StorageSubSystem object.

Syntax

Set-StorageSubSystem
   [-Description <String>]
   -UniqueId <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   [-InputObject] <CimInstance[]>
   [-AutomaticClusteringEnabled <Boolean>]
   [-FaultDomainAwarenessDefault <FaultDomainType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   [-InputObject] <CimInstance[]>
   [-Description <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   [-Description <String>]
   -Name <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   [-Description <String>]
   [-FriendlyName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   -UniqueId <String>
   [-AutomaticClusteringEnabled <Boolean>]
   [-FaultDomainAwarenessDefault <FaultDomainType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   [-FriendlyName] <String>
   [-AutomaticClusteringEnabled <Boolean>]
   [-FaultDomainAwarenessDefault <FaultDomainType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Set-StorageSubSystem
   -Name <String>
   [-AutomaticClusteringEnabled <Boolean>]
   [-FaultDomainAwarenessDefault <FaultDomainType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Set-StorageSubSystem cmdlet modifies the properties of the specified StorageSubSystem object.

Examples

EXAMPLE 1

PS C:\> $inpobject = (Get-StorageSubSystem)
PS C:\> Set-StorageSubSystem -InputObject $inpobject -Description "Non-Production Testing only"

This example changes the Description field on a StorageSubSystem object.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-AutomaticClusteringEnabled

Indicates that storage pools and virtual disks are automatically added to the cluster. By default, storage pools and virtual disks in a cluster are automatically added to the cluster. If you want to disable this, set the value of this parameter to $False.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

-Description

Specifies a description of the object. The description may be defined by a user.

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

-FaultDomainAwarenessDefault

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

  • PhysicalDisk
  • StorageScaleUnit
  • StorageChassis
  • StorageEnclosure
  • StorageRack

The fault domain specifies at what level you want to be fault tolerant. For example, specify StorageScaleUnit to store data copies on separate nodes of a Storage Spaces Direct cluster. This cmdlet refers to nodes of a Storage Spaces Direct cluster as storage scale units because you can expand the scale of the cluster by adding more nodes.

Type:FaultDomainType
Accepted values:PhysicalDisk, StorageEnclosure, StorageScaleUnit, StorageChassis, StorageRack
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Specifies the friendly name of the storage subsystem to modify.

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

-InputObject

Specifies the input object that is used in a pipeline command.

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

-Name

Specifies the name of the storage subsystem to modify.

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

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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

-UniqueId

Specifies the ID of the storage subsystem to modify.

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

Inputs

CimInstance

You can use the pipeline operator to pass an array of MSFT_StorageSubsytem objects to the InputObject parameter.

Outputs

None