Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-StorageSubsystem

Set-StorageSubsystem

storagecmdlets.cdxml

Synopsis

Sets the friendly name or description of the specified StorageSubsystem object.

Syntax

Set-StorageSubsystem [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-StorageSubsystem [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [-Name] [<CommonParameters>]

Set-StorageSubsystem [-InputObject] [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [<CommonParameters>]

Set-StorageSubsystem [-FriendlyName] [-AsJob] [-AutomaticClusteringEnabled] [-CimSession] [-ThrottleLimit] [<CommonParameters>]

Set-StorageSubsystem [-AsJob] [-AutomaticClusteringEnabled] [-CimSession] [-ThrottleLimit] [-UniqueId] [<CommonParameters>]

Set-StorageSubsystem [-AsJob] [-AutomaticClusteringEnabled] [-CimSession] [-ThrottleLimit] [-Name] [<CommonParameters>]

Set-StorageSubsystem [-InputObject] [-AsJob] [-AutomaticClusteringEnabled] [-CimSession] [-ThrottleLimit] [<CommonParameters>]

Set-StorageSubsystem [-FriendlyName] [-AsJob] [-CimSession] [-Description] [-ThrottleLimit] [<CommonParameters>]

Detailed Description

The Set-StorageSubystem cmdlet sets the friendly name or description of the specified StorageSubsystem object.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AutomaticClusteringEnabled <Boolean>

Indicates whether the provider automatically clusters the spaces and pools in the clustered subsystem. If you specify a value of $False for this parameter, you must manually add the pool or virtual disk to the cluster.

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

-FriendlyName <String>

Specifies a friendly name for a disk. The friendly name may be defined by a user and is not guaranteed to be unique.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Accepts an object from the pipeline as input.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Name <String>

ps_storage_name_para

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 an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

Aliases

Id

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem

Return Type

None

Notes

None

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"

Online Version
Get-StorageSubsystem