Register-StorageSubsystem

Article
06/30/2015

Register-StorageSubsystem

Connects to storage subsystems on a remote computer.

Syntax

Parameter Set: ByName
Register-StorageSubsystem [-ProviderName] <String[]> -ComputerName <String> [-AsJob] [-CimSession <CimSession[]> ] [-Credential <PSCredential> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Register-StorageSubsystem -ComputerName <String> -ProviderUniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Credential <PSCredential> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Register-StorageSubsystem -ComputerName <String> -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Credential <PSCredential> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Register-StorageSubsystem cmdlet connects to storage subsystems on a remote computer or cluster. In data centers and clustered environments, a management node manages storage on the remote computers. From the management node, you must connect to the storage subsystems on the remote computer or cluster before you can manage storage on the remote computer.

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

-ComputerName<String>

Specifies the name of a remote computer. Specify the IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NetBIOS name.

Aliases	CN
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies a PSCredential object that contains the user credentials for the remote computer. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

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

-ProviderName<String[]>

Specifies an array of names of providers. The cmdlet connects to the storage subsystems that are managed by the storage providers 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 connects to the storage subsystems that are managed by the storage providers that you specify.

Aliases	ProviderId
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

<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 MSFT_StorageProvider object to the InputObject parameter.

Outputs

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

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

This cmdlet returns an MSFT_StorageSubsystem object. You can use this object to perform storage management operations on the remote computer.

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: Register a storage subsystem on a remote computer

This command registers the storage subsystem named Storage Spaces Management Provider on the computer named StorageCluster01.

PS C:\> Register-StorageSubsystem -ProviderName "Storage Spaces Management Provider" –ComputerName "StorageCluster01"

Unregister-StorageSubsystem

Get-Credential

Register-StorageSubsystem