Unregister-StorageSubsystem

Unregister-StorageSubsystem

Disconnects from storage subsystems on a remote computer.

Syntax

Parameter Set: ByName
Unregister-StorageSubsystem [-ProviderName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-StorageSubSystemUniqueId <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Unregister-StorageSubsystem -ProviderUniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-StorageSubSystemUniqueId <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Unregister-StorageSubsystem -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-StorageSubSystemUniqueId <String> ] [-ThrottleLimit <Int32> ] [ <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

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

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

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

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

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

  You can use the pipeline operator to pass an MSFT_StorageSubsystem object to this cmdlet, which maps the UniqueID property by name to the StorageSubsystemUniqueID parameter.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

  If you specify the Passthru parameter, this cmdlet returns an object that represents the storage providers that you disconnected.

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: 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"

Related topics

Register-StorageSubsystem