Edit

Register-StorageSubsystem

  • Reference
Module:
Storage

Connects to storage subsystems on a remote computer.

Syntax

Register-StorageSubsystem
        [-ProviderName] <String[]>
        -ComputerName <String>
        [-Credential <PSCredential>]
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [<CommonParameters>]
Register-StorageSubsystem
        -ProviderUniqueId <String[]>
        -ComputerName <String>
        [-Credential <PSCredential>]
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [<CommonParameters>]
Register-StorageSubsystem
        -InputObject <CimInstance[]>
        -ComputerName <String>
        [-Credential <PSCredential>]
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [<CommonParameters>]

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.

Examples

Example 1: Register a storage subsystem on a remote computer

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

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

Parameters

-AsJob

ps_cimcommon_asjob

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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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

-ComputerName

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.

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

-Credential

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.

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

-InputObject

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.

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

-ProviderName

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

Type:String[]
Aliases:ProviderId
Position:Named
Default value:None
Required:True
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 MSFT_StorageProvider object to the InputObject parameter.

Outputs

CimInstance

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