Edit

Unregister-StorageSubsystem

  • Reference
Module:
Storage

Disconnects from storage subsystems on a remote computer.

Syntax

Unregister-StorageSubsystem
          [-ProviderName] <String[]>
          [-StorageSubSystemUniqueId <String>]
          [-Force]
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [-PassThru]
          [<CommonParameters>]
Unregister-StorageSubsystem
          -ProviderUniqueId <String[]>
          [-StorageSubSystemUniqueId <String>]
          [-Force]
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [-PassThru]
          [<CommonParameters>]
Unregister-StorageSubsystem
          -InputObject <CimInstance[]>
          [-StorageSubSystemUniqueId <String>]
          [-Force]
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [-PassThru]
          [<CommonParameters>]

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.

Examples

Example 1: Disconnect from storage subsystems on a remote computer

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

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

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProviderName

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProviderUniqueId

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.

Type:String[]
Aliases:ProviderId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageSubSystemUniqueId

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.

Type:String
Aliases:UniqueId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

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

CimInstance

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

CimInstance

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

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).