Get-StorageSubSystem
Gets one or more StorageSubSystem objects.
Syntax
ByFriendlyName (Default)
Get-StorageSubSystem
[[-FriendlyName] <String[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByUniqueId
Get-StorageSubSystem
[-UniqueId <String[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByName
Get-StorageSubSystem
[-Name <String[]>]
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByStorageFaultDomain
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StorageFaultDomain <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByFileServer
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-FileServer <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByVolume
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-Volume <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByPartition
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-Partition <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByDisk
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-Disk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByOffloadDataTransferSetting
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-OffloadDataTransferSetting <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByInitiatorId
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-InitiatorId <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByTargetPortal
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-TargetPortal <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByTargetPort
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-TargetPort <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByMaskingSet
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-MaskingSet <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByVirtualDisk
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-VirtualDisk <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByStoragePool
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StoragePool <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByStorageNode
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StorageNode <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByStorageProvider
Get-StorageSubSystem
[-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>]
[-Model <String[]>]
[-StorageProvider <CimInstance>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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-StorageSubSystem
This example returns a list of all visible StorageSubSystem objects across all accessible StorageProvider objects.
Example 2: Get the Windows Storage subsystem
PS C:\>Get-StorageSubSystem -Model "Storage Spaces"
FriendlyName HealthStatus OperationalStatus
------------ ------------ -----------------
Storage Spaces on SRV1 Healthy OK
This example returns only the StorageSubSystem object for the Storage Spaces provider.
Example 3: Get all unhealthy storage subsystems
PS C:\>Get-StorageSubSystem -HealthStatus Unhealthy
This 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-StorageSubSystem
This 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
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Disk
Specifies a Disk for which this cmdlet gets storage subsystems. To obtain a Disk object, use the Get-Disk cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByDisk
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FileServer
Specifies the file server on which to get storage subsystems. To obtain a FileServer object, use the Get-StorageFileServer cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFileServer
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FriendlyName
Specifies the friendly name of the storage subsystem to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFriendlyName
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-HealthStatus
Specifies the health status for which this cmdlet gets storage subsystems. The acceptable values for this parameter are: Healthy, Warning, and Unhealthy.
Parameter properties
| Type: | HealthStatus[] |
| Default value: | None |
| Accepted values: | Healthy, Warning, Unhealthy |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByInitiatorId
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Manufacturer
Specifies a manufacturer of storage subsystems to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaskingSet
Gets the StorageSubSystem for the specified MaskingSet object. Enter a MaskingSet CIM object. The MaskingSet object is exposed by the Get-MaskingSet cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByMaskingSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Model
Specifies a model for which to get storage subsystems.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Gets the StorageSubSystem with the specified name.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByOffloadDataTransferSetting
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Partition
Specifies a partition associated with a storage subsystem to get. To obtain a Partition object, use the Get-Partition cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPartition
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StorageFaultDomain
Specifies a storage fault ___domain associated with a storage subsystem to get. To obtain a StorageFaultDomain object, use the Get-StorageFaultDomain cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PhysicalDisk, StorageEnclosure, StorageScaleUnit, StorageChassis, StorageRack, StorageSite |
Parameter sets
ByStorageFaultDomain
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StorageNode
Specifies a storage node as a CimInstance object. The cmdlet gets storage subsystems on the node that you specify. To obtain a storage node object, use the Get-StorageNode cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByStorageNode
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StoragePool
Gets the StorageSubSystem associated with the specified StoragePool object. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByStoragePool
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StorageProvider
Gets the StorageSubSystem associated with the specified StorageProvider object. The Storage Provider CIM object is exposed by the Get-StorageProvider cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByStorageProvider
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetPort
Gets the StorageSubSystem associated with the specified TargetPort object. The TargetPort CIM object is exposed by the Get-TargetPort cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByTargetPort
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetPortal
Gets the StorageSubSystem associated with the specified TargetPortal object. The TargetPortal CIM object is exposed by the Get-TargetPortal cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByTargetPortal
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UniqueId
Gets the StorageSubSystem with the specified UniqueID value.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
ByUniqueId
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-VirtualDisk
Gets the StorageSubSystem associated with the specified VirtualDisk object. The Virtual Disk CIM object is exposed by the Get-VirtualDisk cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByVirtualDisk
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Volume
Specifies a volume that is associated the storage subsystem that this cmdlet gets. To obtain a Volume object, use the Get-Volume cmdlet.
Parameter properties
| Type: | CimInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByVolume
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
CimInstance
You can use the pipeline operator to pass an InitiatorID object to the InitiatorID parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a MaskingSet object to the MaskingSet parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass an OffloadDataTransferSetting object to the OffloadDataTransferSetting parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a PhysicalDisk object to the PhysicalDisk parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a StorageNode object to the StorageNode parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a StoragePool object to the StoragePool parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a StorageProvider object to the StorageProvider parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a TargetPort object to the TargetPort parameter to get the storage subsystem associated with the object.
CimInstance
You can the pipeline operator to pass a TargetPortal object to the TargetPortal parameter to get the storage subsystem associated with the object.
CimInstance
You can use the pipeline operator to pass a VirtualDisk object to the VirtualDisk parameter to get the storage subsystem associated with the object.
Outputs
CimInstance
This cmdlet outputs an object representing a storage subsystem.