Get-StorageSubsystem
Gets one or more StorageSubsystem objects.
Syntax
Get-StorageSubsystem
[[-FriendlyName] <String[]>]
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-ThrottleLimit <Int32>]
[-VirtualDisk <CimInstance>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-PhysicalDisk <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-OffloadDataTransferSetting <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-ThrottleLimit <Int32>]
[-UniqueId <String[]>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-TargetPortal <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-TargetPort <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-MaskingSet <CimInstance>]
[-Model <String[]>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-InitiatorId <CimInstance>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StoragePool <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StorageProvider <CimInstance>]
[-ThrottleLimit <Int32>] Get-StorageSubsystem
[-AsJob]
[-CimSession <CimSession[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-Name <String[]>]
[-ThrottleLimit <Int32>] Description
The Get-StorageSubsystem cmdlet gets one or more StorageSubsystem objects. If no parameters are specified, then all subsystems on the system will be returned. If two parameters are specified that conflict with unique values, then no subsystem will be returned; since none match that criteria.
Examples
Example 1: Get all storage subsystems
PS C:\>Get-StorageSubsystemThis example returns a list of all visible StorageSubsystem objects across all accessible StorageProvider objects.
Example 2: Get the Storage Spaces subsystem
PS C:\>Get-StorageSubSystem -Model "Storage Spaces"
FriendlyName HealthStatus OperationalStatus
------------ ------------ -----------------
Storage Spaces on SRV1 Healthy OKThis example returns only the StorageSubsystem object for the Storage Spaces provider.
Example 3: Get all unhealthy storage subsystems
PS C:\>Get-StorageSubSystem -HealthStatus UnhealthyThis example gets all storage subsystems in an unhealthy state.
Example 4: Get storage subsystems that have SMPs that support ODX
PS C:\>Get-OffloadDataTransferSetting | Get-StorageSubSystemThis example displays all storage subsystems on storage management providers that support Windows Offloaded Data Transfers (ODX). Storage arrays that support ODX using the SMI-S protocol are not shown.
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 |
-FriendlyName
Specifies the friendly name of the storage subsystem to get.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthStatus
Gets all storage subsystems that have the specified health status. Acceptable values are Healthy, Warning, and Unhealthy.
| Type: | HealthStatus[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitiatorId
Gets the storage subsystem associated with the specified InitiatorId object. Enter an InitiatorID CIM object. The InitiatorID object is exposed by the Get-InitiatorId cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Manufacturer
Gets StorageSubsystem objects with the specified manufacturer name.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MaskingSet
Gets the StorageSubsystem for the specified MaskingSet object. Enter a MaskingSet CIM object. The MaskingSet object is exposed by the Get-MaskingSet cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Model
Gets the StorageSubsystem with the specified model string.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Gets the StorageSubsystem with the specified name.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OffloadDataTransferSetting
Gets the StorageSubsystem associated with the specified OffloadDataTransferSetting object. The Offload Data Transfer Setting CIM object is exposed by the Get-OffloadDataTransferSetting cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PhysicalDisk
Gets the StorageSubsystem associated with the specified PhysicalDisk object. The Physical Disk CIM object is exposed by the Get-PhysicalDisk cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StoragePool
Gets the StorageSubsystem associated with the specified StoragePool object. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageProvider
Gets the StorageSubsystem associated with the specified StorageProvider object. The Storage Provider CIM object is exposed by the Get-StorageProvider cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetPort
Gets the StorageSubsystem associated with the specified TargetPort object. object as input. The TargetPort CIM object is exposed by the Get-TargetPort cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetPortal
Gets the StorageSubsystem associated with the specified TargetPortal object. object as input. The TargetPortal CIM object is exposed by the Get-TargetPortal cmdlet.
| Type: | CimInstance |
| 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 |
-UniqueId
Gets the StorageSubsystem with the specified UniqueID value.
| Type: | String[] |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualDisk
Gets the StorageSubsystem associated with the specified VirtualDisk object. object as input. The Virtual Disk CIM object is exposed by the Get-VirtualDisk cmdlet.
| Type: | CimInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
You can pipe an InitiatorID object to the InitiatorID parameter to get the storage subsystem associated with the object.
You can pipe a MaskingSet object to the MaskingSet parameter to get the storage subsystem associated with the object.
You can pipe an OffloadDataTransferSetting object to the OffloadDataTransferSetting parameter to get the storage subsystem associated with the object.
You can pipe a PhysicalDisk object to the PhysicalDisk parameter to get the storage subsystem associated with the object.
You can pipe a StoragePool object to the StoragePool parameter to get the storage subsystem associated with the object.
You can pipe a StorageProvider object to the StorageProvider parameter to get the storage subsystem associated with the object.
You can pipe a TargetPort object to the TargetPort parameter to get the storage subsystem associated with the object.
You can pipe a VirtualDisk object to the VirtualDisk parameter to get the storage subsystem associated with the object.
Outputs
This cmdlet outputs an object representing a storage subsystem.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for