Set-StorageSubsystem

Set-StorageSubsystem

Modifies the properties of a StorageSubsystem object.

Syntax

Parameter Set: ByUniqueIdDescription
Set-StorageSubsystem -UniqueId <String> [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFriendlyNameDescription
Set-StorageSubsystem [-FriendlyName] <String> [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByFriendlyNameSetAttributes
Set-StorageSubsystem [-FriendlyName] <String> [-AutomaticClusteringEnabled] [-CimSession <CimSession[]> ] [-FaultDomainAwarenessDefault <FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByNameDescription
Set-StorageSubsystem -Name <String> [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByNameSetAttributes
Set-StorageSubsystem -Name <String> [-AutomaticClusteringEnabled] [-CimSession <CimSession[]> ] [-FaultDomainAwarenessDefault <FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByObjectDescription
Set-StorageSubsystem [-CimSession <CimSession[]> ] [-Description <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByObjectSetAttributes
Set-StorageSubsystem [-AutomaticClusteringEnabled] [-CimSession <CimSession[]> ] [-FaultDomainAwarenessDefault <FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByUniqueIdSetAttributes
Set-StorageSubsystem -UniqueId <String> [-AutomaticClusteringEnabled] [-CimSession <CimSession[]> ] [-FaultDomainAwarenessDefault <FaultDomainType> {PhysicalDisk | StorageEnclosure | StorageScaleUnit | StorageChassis | StorageRack} ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]




Detailed Description

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

Parameters

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FaultDomainAwarenessDefault<FaultDomainType>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FriendlyName<String>

Specifies the friendly name of the storage subsystem to modify.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the storage subsystem to modify.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UniqueId<String>

Specifies the ID of the storage subsystem to modify.


Aliases

Id

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

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

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

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.

  • None

Notes

  • The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example changes the Description field on a StorageSubsystem object.


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

Related topics

Community Additions

ADD
Show: