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

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

-FriendlyName<String[]>

Specifies the friendly name of the storage subsystem to get.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-HealthStatus<HealthStatus[]>

Gets all storage subsystems that have the specified health status. Acceptable values are Healthy, Warning, and Unhealthy.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InitiatorId<CimInstance>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Manufacturer<String[]>

Gets StorageSubsystem objects with the specified manufacturer name.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaskingSet<CimInstance>

Gets the StorageSubsystem for the specified MaskingSet object. Enter a MaskingSet CIM object. The MaskingSet object is exposed by the Get-MaskingSet cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Model<String[]>

Gets the StorageSubsystem with the specified model string.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Gets the StorageSubsystem with the specified name.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OffloadDataTransferSetting<CimInstance>

Gets the StorageSubsystem associated with the specified OffloadDataTransferSetting object. The Offload Data Transfer Setting CIM object is exposed by the Get-OffloadDataTransferSetting cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-PhysicalDisk<CimInstance>

Gets the StorageSubsystem associated with the specified PhysicalDisk object. The Physical Disk CIM object is exposed by the Get-PhysicalDisk cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StorageEnclosure<CimInstance>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StorageNode<CimInstance>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StoragePool<CimInstance>

Gets the StorageSubsystem associated with the specified StoragePool object. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StorageProvider<CimInstance>

Gets the StorageSubsystem associated with the specified StorageProvider object. The Storage Provider CIM object is exposed by the Get-StorageProvider cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-TargetPort<CimInstance>

Gets the StorageSubsystem associated with the specified TargetPort object. The TargetPort CIM object is exposed by the Get-TargetPort cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-TargetPortal<CimInstance>

Gets the StorageSubsystem associated with the specified TargetPortal object. The TargetPortal CIM object is exposed by the Get-TargetPortal cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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

-UniqueId<String[]>

Gets the StorageSubsystem with the specified UniqueID value.

Aliases

Id

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VirtualDisk<CimInstance>

Gets the StorageSubsystem associated with the specified VirtualDisk object. The Virtual Disk CIM object is exposed by the Get-VirtualDisk cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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: Get all storage subsystems

This example returns a list of all visible StorageSubsystem objects across all accessible StorageProvider objects.

Example 3: Get all unhealthy storage subsystems

Example 4: Get storage subsystems that have SMPs that support ODX

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.