NAME
Get-StoragePool
SYNOPSIS
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] ] [-CimSession ] [-HealthStatus ]
[-IsPrimordial ] [-ThrottleLimit ] [-Usage ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-StorageTier ] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-PhysicalDisk ] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-StorageNode ] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-StorageSubSystem ] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-OtherUsageDescription ] [-ThrottleLimit ] [-Usage ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ] [-Name
] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-ResiliencySetting ] [-ThrottleLimit ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-ThrottleLimit ] [-UniqueId ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-ThrottleLimit ] [-VirtualDisk ] []
Get-StoragePool [-CimSession ] [-HealthStatus ] [-IsPrimordial ]
[-StorageJob ] [-ThrottleLimit ] []
Get-StoragePool [-Volume ] []
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.
PARAMETERS
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FriendlyName []
Specifies the friendly name of the storage pool to get.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
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.
Required? false
Position? named
Default value none
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name []
Specifies the name of the storage pool to get.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OtherUsageDescription []
Gets any storage pools that match the specified OtherUsageDescription string.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-StorageSubSystem []
Accepts a StorageSubsystem object as input. The Storage Subsystem CIM object is exposed by the
Get-StorageSubsystem cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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 PowerShellr 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.
Required? false
Position? named
Default value none
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk
http://msdn.microsoft.com/library/windows/desktop/hh830532.aspx
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_ResiliencySetting
http://msdn.microsoft.com/library/windows/desktop/hh830538.aspx
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageNode
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem
http://msdn.microsoft.com/library/windows/desktop/hh830569.aspx
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageTier
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.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk
http://msdn.microsoft.com/library/windows/desktop/hh830584.aspx
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
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool
http://msdn.microsoft.com/library/windows/desktop/hh830551.aspx
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.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816410
Get-Volume
New-StoragePool
Remove-StoragePool
Set-StoragePool
Get-StorageJob
Get-StorageNode
Get-StorageTier