Get-StoragePool

Module:

Storage

Gets a specific storage pool, or a set of StoragePool objects either from all storage subsystems across all storage providers, or optionally a filtered subset based on specific parameters.

Syntax

Get-StoragePool
   [[-FriendlyName] <String[]>]
   [-Usage <Usage[]>]
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-UniqueId <String[]>]
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-Name <String[]>]
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-Usage <Usage[]>]
   [-OtherUsageDescription <String[]>]
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-StorageJob <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-Volume <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-StorageTier <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-ResiliencySetting <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-VirtualDisk <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-PhysicalDisk <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-StorageNode <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-StoragePool
   [-IsPrimordial <Boolean[]>]
   [-HealthStatus <HealthStatus[]>]
   [-StorageSubSystem <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-StoragePool cmdlet returns either a specific storage pool, or a set of StoragePool objects either from all storage subsystems across all storage providers, or optionally a filtered subset based on specific parameters.

Examples

Example 1: Get all storage pools

PS C:\>Get-StoragePool
FriendlyName            OperationalStatus       HealthStatus            IsPrimordial            IsReadOnly
------------            -----------------       ------------            ------------            ----------
CompanyData             OK                      Healthy                 False                   False
Primordial              OK                      Healthy                 True                    False

This example lists all storage pools, (when run without parameter) from all Storage Management Providers, from all storage subsystems. This list may optionally be filtered using one or more parameters.

Example 2: Get all storage pools (not including primordial pools)

PS C:\>Get-StoragePool -IsPrimordial $False
FriendlyName            OperationalStatus       HealthStatus            IsPrimordial            IsReadOnly
------------            -----------------       ------------            ------------            ----------
CompanyData             OK                      Healthy                 False                   False

This example lists all (concrete) storage pools, excluding primordial pools (which store physical disks that have yet to be added to a concrete storage pool).

Example 3: Get all storage pools that support the Mirror resiliency setting

PS C:\>Get-ResiliencySetting -Name Mirror | Get-StoragePool
FriendlyName                  OperationalStatus             HealthStatus                  IsPrimordial                  IsReadOnly
------------                  -----------------             ------------                  ------------                  ----------
CompanyData                   OK                            Healthy                       False                         False
Primordial                    OK                            Healthy                       True                          False

This example uses the Get-ResiliencySetting cmdlet to retrieve ResiliencySetting objects that represent each storage pool that supports the specified resiliency setting (also known as storage layout), in this case Mirror, and then pipes the array of objects to the Get-StoragePool cmdlet.

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

-FriendlyName

Specifies the friendly name of the storage pool to get.

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

-HealthStatus

Specifies the health status(es) of the storage pool to get. Specify one or more of the following values: Healthy, Warning, Unhealthy, or Unknown.

Type:	HealthStatus[]
Accepted values:	Healthy, Warning, Unhealthy, Unknown
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IsPrimordial

Specifies whether to get (concrete) storage pools or primordial storage pools (which store physical disks that have yet to be added to a concrete storage pool). To get (concrete) storage pools, specify the $False Boolean value. To get primordial pools, specify the $True Boolean value.

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

-Name

Specifies the name of the storage pool to get.

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

-OtherUsageDescription

Gets any storage pools that match the specified OtherUsageDescription string.

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

-PhysicalDisk

Gets the storage pool that contains the specified PhysicalDisk object. Enter a PhysicalDisk CIM 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

-ResiliencySetting

Gets the storage pool associated with the specified ResiliencySetting object. Enter a single ResiliencySetting CIM object as input, or pipe multiple ResiliencySetting objects to the Get-StoragePool cmdlet to view all pools that support the specified resiliency setting. Resiliency Setting CIM objects are exposed by the Get-ResiliencySetting cmdlet.

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

-StorageJob

Specifies an outstanding storage job as a CimInstance object. The cmdlet gets the storage pools associated with the storage job that you specify. To obtain a storage job, use the Get-StorageJob cmdlet.

Type:	CimInstance
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 pools that have read-write access 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

-StorageSubSystem

Accepts a StorageSubsystem object as input. The Storage Subsystem CIM object is exposed by the Get-StorageSubsystem cmdlet.

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

-StorageTier

Specifies a storage tier as a CimInstance object. The cmdlet gets storage pools that contain the storage tier that you specify. To obtain a storage tier object, use the Get-StorageTier 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

Specifies the UniqueID of the storage pool to get. If the UniqueID includes brackets, enclose the string in quotation marks.

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

-Usage

Gets any storage pools that match the specified Usage value. Acceptable values: ReservedAsDeltaReplicaContainer, ReservedForComputerSystem, ReservedForLocalReplicationServices, ReservedForMigrationServices, ReservedForRemoteReplicationServices, ReservedForSparing, Unknown, Unrestricted, and Other

Type:	Usage[]
Accepted values:	Unknown, Other, Unrestricted, ReservedForComputerSystem, ReservedAsDeltaReplicaContainer, ReservedForMigrationServices, ReservedForLocalReplicationServices, ReservedForRemoteReplicationServices, ReservedForSparing
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualDisk

Gets the storage pool associated with the specified virtual disk object. Enter a VirtualDisk CIM 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. The cmdlet gets the storage nodes that correspond to the volume that you specify. 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 MSFT_PhysicalDisk object to the PhysicalDisk parameter to get the storage pool associated with the PhysicalDisk object.

CimInstance

You can use the pipeline operator to pass an MSFT_ResiliencySetting object to the ResiliencySetting parameter to get the storage pool associated with the ResiliencySetting object.

CimInstance

You can use the pipeline operator to pass an MSFT_StorageNode object to the StorageNode parameter to get the storage pool associated with the StorageNode object.

CimInstance

You can use the pipeline operator to pass an MSFT_StorageSubsystem object to the StorageSubsystem parameter to get the storage pool associated with the StorageSubsystem object.

CimInstance

You can use the pipeline operator to pass an MSFT_StorageTier object to the StorageTier parameter to get the storage pool associated with the StorageTier object.

CimInstance

You can use the pipeline operator to pass an MSFT_VirtualDisk object to the VirtualDisk parameter to get the storage pool associated with the VirtualDisk object.

Outputs

CimInstance

The Get-StoragePool cmdlet returns objects representing storage pools.

Notes

• To reduce load times, storage providers other than the Storage Spaces provider might not perform a full discovery of objects on initial load. As a result, this cmdlet might show an empty or incomplete listing of objects from a particular storage provider. To update the storage provider cache so that storage objects are available from a storage provider, use the Update-StorageProviderCache cmdlet.
• 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.
• When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).

Related Links

• Get-Volume
• New-StoragePool
• Remove-StoragePool
• Set-StoragePool
• Get-StorageJob
• Get-StorageNode
• Get-StorageTier