Set-StorageSubSystem

Module:

Storage Module

Modifies the properties of a StorageSubSystem object.

Syntax

ByUniqueIdDescription (Default)

Set-StorageSubSystem
    -UniqueId <String>
    [-Description <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByObjectSetAttributes

Set-StorageSubSystem
    [-InputObject] <CimInstance[]>
    [-AutomaticClusteringEnabled <Boolean>]
    [-FaultDomainAwarenessDefault <FaultDomainType>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByObjectDescription

Set-StorageSubSystem
    [-InputObject] <CimInstance[]>
    [-Description <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByNameDescription

Set-StorageSubSystem
    -Name <String>
    [-Description <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByFriendlyNameDescription

Set-StorageSubSystem
    [-FriendlyName] <String>
    [-Description <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByUniqueIdSetAttributes

Set-StorageSubSystem
    -UniqueId <String>
    [-AutomaticClusteringEnabled <Boolean>]
    [-FaultDomainAwarenessDefault <FaultDomainType>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByFriendlyNameSetAttributes

Set-StorageSubSystem
    [-FriendlyName] <String>
    [-AutomaticClusteringEnabled <Boolean>]
    [-FaultDomainAwarenessDefault <FaultDomainType>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByNameSetAttributes

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.

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

-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.

Parameter properties

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

Parameter sets

ByObjectSetAttributes

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

ByUniqueIdSetAttributes

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

ByFriendlyNameSetAttributes

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

ByNameSetAttributes

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

Parameter properties

Type:	CimSession[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Session

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 of the object. The description may be defined by a user.

Parameter properties

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

Parameter sets

ByUniqueIdDescription

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

ByObjectDescription

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

ByNameDescription

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

ByFriendlyNameDescription

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

Parameter properties

Type:	FaultDomainType
Default value:	None
Accepted values:	PhysicalDisk, StorageEnclosure, StorageScaleUnit, StorageChassis, StorageRack
Supports wildcards:	False
DontShow:	False

Parameter sets

ByObjectSetAttributes

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

ByUniqueIdSetAttributes

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

ByFriendlyNameSetAttributes

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

ByNameSetAttributes

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

-FriendlyName

Specifies the friendly name of the storage subsystem to modify.

Parameter properties

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

Parameter sets

ByFriendlyNameDescription

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

ByFriendlyNameSetAttributes

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

-InputObject

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

Parameter properties

Type:	CimInstance[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByObjectSetAttributes

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

ByObjectDescription

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

-Name

Specifies the name of the storage subsystem to modify.

Parameter properties

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

Parameter sets

ByNameDescription

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

ByNameSetAttributes

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

Parameter properties

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

-UniqueId

Specifies the ID of the storage subsystem to modify.

Parameter properties

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

Parameter sets

ByUniqueIdDescription

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

ByUniqueIdSetAttributes

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

Inputs

CimInstance

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

Outputs

None

Related Links

• Get-StorageSubSystem