Get-StorageSubSystem

  • Reference
Module:
Storage

Gets one or more StorageSubSystem objects.

Syntax

Get-StorageSubSystem
   [[-FriendlyName] <String[]>]
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-UniqueId <String[]>]
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-Name <String[]>]
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-StorageFaultDomain <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-FileServer <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-Volume <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-Partition <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-Disk <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-OffloadDataTransferSetting <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-InitiatorId <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-TargetPortal <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-TargetPort <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-MaskingSet <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-VirtualDisk <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-StoragePool <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-StorageSubSystem
   [-HealthStatus <HealthStatus[]>]
   [-Manufacturer <String[]>]
   [-Model <String[]>]
   [-StorageNode <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
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.

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

-Disk

Specifies a Disk for which this cmdlet gets storage subsystems. To obtain a Disk object, use the Get-Disk cmdlet.

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

-FileServer

Specifies the file server on which to get storage subsystems. To obtain a FileServer object, use the Get-StorageFileServer cmdlet.

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

-FriendlyName

Specifies the friendly name of the storage subsystem to get.

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

-HealthStatus

Specifies the health status for which this cmdlet gets storage subsystems. The acceptable values for this parameter are: Healthy, Warning, and Unhealthy.

Type:HealthStatus[]
Accepted values:Healthy, Warning, Unhealthy
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

Specifies a manufacturer of storage subsystems to get.

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

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

-Model

Specifies a model for which to get storage subsystems.

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

-Partition

Specifies a partition associated with a storage subsystem to get. To obtain a Partition object, use the Get-Partition cmdlet.

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

-StorageFaultDomain

Specifies a storage fault domain associated with a storage subsystem to get. To obtain a StorageFaultDomain object, use the Get-StorageFaultDomain cmdlet.

Type:CimInstance
Aliases:PhysicalDisk, StorageEnclosure, StorageScaleUnit, StorageChassis, StorageRack, StorageSite
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

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. 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. 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. 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

-Volume

Specifies a volume that is associated the storage subsystem that this cmdlet gets. To obtain a Volume object, use the Get-Volume cmdlet.

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

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.