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
 

Unregister-StorageSubsystem

Unregister-StorageSubsystem

storageprovider.cdxml

Synopsis

Disconnects from storage subsystems on a remote computer.

Syntax

Unregister-StorageSubsystem [-ProviderName] [-AsJob] [-CimSession] [-Force] [-PassThru] [-StorageSubSystemUniqueId] [-ThrottleLimit] [<CommonParameters>]

Unregister-StorageSubsystem [-AsJob] [-CimSession] [-Force] [-PassThru] [-StorageSubSystemUniqueId] [-ThrottleLimit] [-ProviderUniqueId] [<CommonParameters>]

Unregister-StorageSubsystem [-AsJob] [-CimSession] [-Force] [-PassThru] [-StorageSubSystemUniqueId] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Detailed Description

The Unregister-StorageSubsystem cmdlet disconnects storage management in Windows Server® 2012 R2 from storage subsystems on a remote computer or remote cluster. When you disconnect from a storage subsystem, you cannot use the management node to remotely manage the storage subsystem.

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

-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

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the StorageProvider object to use as input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProviderName <String[]>

Specifies an array of names of providers. The cmdlet disconnects from the storage subsystems that are managed by the storage provider that you specify.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ProviderUniqueId <String[]>

Specifies an array of unique IDs of providers. The cmdlet disconnects from the storage subsystems that are managed by the storage provider that you specify. Windows Server® 2012 retains the provider ID through computer restarts.

Aliases

ProviderId

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StorageSubSystemUniqueId <String>

Specifies the unique ID of the storage subsystem in the system. The cmdlet disconnects from the storage subsystem that you specify. Windows Server® 2012 retains the storage subsystem ID through computer restarts.

Aliases

UniqueId

Required?

false

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

Input Type

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

Return Type

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

Notes

None

Examples

Example 1: Disconnect from storage subsystems on a remote computer

This command disconnects Windows Server® 2012 from the storage subsystems that the storage provider named Provider16 manages on the remote computer.

PS C:\> Unregister-StorageSubsystem -ProviderName "Provider16"

Online Version
Register-StorageSubsystem